API documentation

The most detailed documentation is available via Postman.

There is also an interactive SwaggerUI documentation available on localhost:5000/apidocs when running Flask in dev mode.

Applying migrations

Before running app you will have to apply migrations.

From root project directory:

export FLASK_APP=backend.app
flask db upgrade

Running Flask in dev mode

Running backend in development mode exposes SwaggerUI apidocs and enables CORS.

From root project directory:

export FLASK_APP=backend.app
export FLASK_ENV=development
export FLASK_DEBUG=1
flask run

Building docker images

From root project directory:

docker-compose build