Skip to content


Repository files navigation


A Web Schema Visualization App

Run a local dev server

  1. Install Elasticsearch at localhost:9200 (follow this instruction)

  2. Clone this repo

    git clone
  3. Install system packages (on Ubuntu, for example)

    sudo apt install libcurl4-openssl-dev libssl-dev
  4. Change directory to project folder

    cd discovery-app
  5. Install python dependencies

    pip install -r requirements.txt
  6. Create a under project folder with

    COOKIE_SECRET = '<Any Random String>'
    GITHUB_CLIENT_ID = '<your Github application Client ID>'
    GITHUB_CLIENT_SECRET = '<your Github application Client Secret>'

    Follow this instruction to create your Github Client ID and Secret.

  7. Run dev server

    python --debug

You should now be able to access the homepage at http://localhost:8000/

Run in Docker

First refer to step 5 above to setup the credentials required to run the program. The following commands should be issued under the first level project folder. Make sure you have port 8000 and 9200 not in use when starting containers.


docker-compose up --detach

Stop and restart

docker-compose stop
docker-compose start

Update codebase

docker-compose exec web git pull

Remove containers

docker-compose down