Installing SCE locally

This is an installation guide for SCE beta. Main repository will be always hosted at https://github.com/ctlab/SCE.

SCE: server-side

First of all, SCE is built using docker-compose. This allows us to run multi-container docker applications.

We have three main services in docker-compose:

• Nginx
• Redis
• JS-based backend server

All of these parts will build automatically if you run docker-compose build.

SCE: client-side

Frontend for SCE is build with React + Redux which allows full control over the application state at any point. Frontend is build locally outside of docker-compose container. Building frontend outside of docker-compose container allows us fix client-side bugs and improve client-side behaviour without stopping/restarting docker-compose application.

You can build client side using npm utils:

cd ./sce_js
npm install
npm run build

Datasets

If you want your datasets to show up in SCE, you have to prepare them in a specific way.

Prepare your datasets locally in one folder and make sure to change /path/to/datasets in docker-compose.yaml to this folder you chose.

For each dataset in this folder you will require to create a folder containing the dataset. Detailed guide on how we store dataset is available at here.

Running SCE locally

To run sce locally you will first need to build SCE server-side. Then build client-side js code and then just start docker-compose. Be careful, docker-compose might require sudo privileges.

## building server-side
docker-compose build

## building client-side
cd ./sce_js
npm install
npm run build
cd ..

## running multi-container

docker-compose up

## running multi-container detached

docker-compose up -d