WELCOME

Getting started

1. Install VS Code and Docker Desktop
2. Install Remote Development Extension for VS Code
3. Clone repo
4. Open in VS CODE, then you should see the following notification (Click Reopen in Container):

Development setup

1. Duplicate .env.template and rename it .env and add the secrets.

2. Then Ctrl + Shift + P and select Dev Containers: Rebuild Container

3. Then Ctrl + Shift + P and select Developer: Reload Window this will ensure that the extensions and formatters work properly. This only needs to be done after a container rebuild.

4. Run make migrations in terminal to create new migratrions.

5. Run make migrate in terminal to migrate changes in the database.

6. Run make sync_roles in terminal to add user roles in the database.

7. Run make dev in terminal to run django.

Production

1. Duplicate .env.template and rename it to .env, then add the necessary secrets. Ensure that the value of the DJANGO_ENV environment variable is set to production.
2. Run docker compose up --build in terminal to build the container and to run the server

SQLite database is set up for development purposes, while PostgreSQL is used for the production environment.