Running Locally

HIPPO Gym can be run locally with or without Docker:

Without Docker

To install all the requirements of HIPPO Gym in the root directory and run:

pip3 install -r requirements.txt

In the root directory run the following command. This will need to be run almost every time a change is made in the backend:

python3 updateProject.py

All browsers may not be supported ⚠️

In the App/ directory run:

python3 communicator.py dev

The websocket server is now running at localhost port 5000.

To access the websocket or test the setup, open a browser and go to irll.net?server=ws://localhost:5000 (opens new window)

Error messages can be found in both the terminal running the python program and within the browser's devTools console.

With Docker

In order to run the Docker version in development mode add the 'dev' flag to the end of line 3 in App/xvfb.sh :

xvfb-run -s "-screen 0 1400x900x24" python3 communicator.py dev

Then build and run the container, in the project root directory run:

python3 updateProject.py # select 'n' when asked if you want to deploy the container
docker build -t hippo .
docker run --publish 5000:5000 --rm --name hippo hippo

The websocket server is now accessible at localhost port 5000

To access the websocket or test the setup, open a browser and go to irll.net?server=ws://localhost:5000 (opens new window)

Error messages can be found in the browser's devTools console or in the log file within the docker container.

To stop the docker container run:

docker stop hippo