Local Development

Running Project

This project runs using Docker. It should work consistently on Windows, macOS or Linux machines.

Follow the below steps to run a local development environment.

1. Ensure you have the following installed:

• Docker Desktop

2. Clone the project, cd to it in Terminal/Command Prompt and run the following:

docker compose up

3. Browse the project at http://127.0.0.1:8000/api/health-check/

Creating Superuser

To create a superuser to access the Django admin follow these steps.

1. Run the below command and follow the in terminal instructions:

docker compose run --rm app sh -c "python manage.py createsuperuser"

2. Browse the Django admin at [http://127.0.0.1:8000/admin] and login.

Clearing Storage

To clear all storage (including the database) and start fresh:

docker compose down --volumes
docker compose up