hso / README.md

HSO

Last updated: 4/16/2026GitHub

HSO

Hoist Sequence Optimizer

Structure

  • analysis folder contains all the data and some scripts to play with them
  • server folder contains the python server
  • web folder contains the svelte web app [DEPRECATED]
  • web-react folder contains the react web app

Setup

  • Create a ~/.netrc file with the following contents:

    machine github.com 
    login <github username> 
    password <github token>
    
    • where <github token> can be generated as explained here
    • Give the token access to everything and no expiration date.
  • Create a ~/.npmrc file all details are explained here

Development

Run -

make dev

Stop/clean -

make stop

For the react you need to run npm install first in the directory.

Building and running prod images

  • Server
docker build -t hso-server .
docker run -d -p 5000:80 -e MODULE_NAME="src.app" hso-server
  • Web
export DOCKER_BUIILDKIT=1
docker build -t hso-web  --secret id=github,src=$HOME/.npmrc .
docker run -d -p 80:80 hso-web

Ensure you have the correct .npmrc file in your home directory.

Staging

make staging