SC-Web

About

SC-Web is an intelligent knowledge base user interface. Currently, it is a part of the OSTIS Web Platform.

The long term idea of this project is to create a universal rendering mechanism for interfaces defined inside knowledge bases.

Demo

Quick start

We provide the ostis/sc-web Docker image to simplify the integration of this UI with existing OSTIS-systems.

# Connect to remote sc-server (or another Docker container)
docker run --rm -it -p 8000:8000 ostis/sc-web:latest --server_host=<ip or hostname>
# Connect to server hosted on localhost
docker run --rm -it --network=host ostis/sc-web:latest

Installation

Clone repo:

git clone https://github.com/ostis-ai/sc-web
cd sc-web
git submodule update --init --recursive

If you're using Ubuntu, you can install dependencies using our script:

cd sc-web/scripts
./install_deps_ubuntu.sh
pip3 install -r ../requirements.txt
npm install

Otherwise, the following dependencies should be installed:

• python3
• pip
• nodejs
• npm
• grunt-cli
• python modules: tornado, sqlalchemy, numpy, configparser, py-sc-client

Development notes

To run grunt in watch mode use:

    npm run serve

Watch mode supports livereload. To enable livereload uncomment in client/templates/common.html

    <!-- Enable livereload script for development -->
    <!--<script type="text/javascript" charset="utf-8" src="http://localhost:35729/livereload.js"></script>-->

Building

npm run build

Documentation

Full documentation, including: * core concepts * rationale behind the sc-web * system design * software interfaces

is redistributed in a form of the SCn-TeX document.

or alternatively you can build sc-machine documentation only. To do that refer to the scn-latex-plugin documentation.

Running

SC-Web requires sc-server to be up and running.

Use included scripts to launch the server:

cd sc-web/scripts
./run_scweb.sh`

The UI will listen at localhost:8000.