README.md

Usage instructions

Run with docker

Within the base directory of the project (where the docker-compose.yaml file is located) run the following command:

docker-compose up

Run locally

Python version required

3.10

How to run front end

To run front end, make a cd to the "frontend" folder and execute the following command:

py -m "http.server" 8000 or python3 -m "http.server" 8000

You can change the port number as you like.

How to run back end

Before running, make a cd to the "backend" folder and install dependencies with the following command:

pip install -r requirements.txt

To run back end, make sure you are in the "backend" folder directory and execute the following command:

python app.py or python3 app.py