Skip to main content

Running

Start your application

Docker-compose is used for running the project locally.

Run the development server:

docker-compose up

The docker-compose up command builds your website locally (using docker) and serves it through a development server, ready for you to view at http://localhost/.

The API documentation can be found at http://localhost/docs.

The OpenAPI spec can be found at http://localhost/openapi.json

Without using docker (not recommended)

Navigate to the /api folder, activate local venv, then start backend app.py with Uvicorn:

cd api/src/  # go to the location of app.py
uvicorn app:create_app --reload

Navigate to the /web folder, and then start web application:

yarn start