Backend Challenge

Dependencies

Poetry is used for dependency management. Please install Poetry package management by running the below command as described in Poetry documentation.

curl -sSL https://install.python-poetry.org | python3 -

The above command should work for Linux, macOS, Windows (WSL). However, if you use Windows, please run the following command in PowerShell.

(Invoke-WebRequest -Uri https://install.python-poetry.org -UseBasicParsing).Content | py -

The above steps assume that you have already install Python 3 on your system from https://www.python.org/downloads/. I do not recommend using Windows Store installation of Python as it does not set up your paths correctly.

To install dependencies, please run the following command.

poetry install

Once, dependencies are installed, please active your environment by running the following command.

poetry shell

Database

Database used in this example is SQLite. Please see Docker Compose section for Postgres. In order to get database created and loaded with seed data, please run the following command.

alembic upgrade head

This should create a file called backend.db containing required tables.

Service

Service is implemented using FastAPI. Please run the following command to start up the service.

uvicorn app.main:app --reload

Once the service starts, you should be able to access Swagger API client at the below URL.

http://localhost:8000/docs

Docker Compose

To run the service against a Postgres database in a Docker container, please start up docker compose with the following command.

docker-compose up -d --build

Once the environment is up, please run database migrations using the below command.

docker-compose exec svc alembic upgrade head

Swagger API client should be available at the following URL.

http://localhost:8000/docs

Please stop docker compose environment when done with the below command.

docker-compose down -v

Tests

To run test cases, please run the following command.

pytest