- Install VS Code and Docker Desktop
- Install Remote Development Extension for VS Code
- Clone repo
- Open in VS CODE, then you should see the following notification (Click Reopen in Container):
-
Duplicate
.env.template
and rename it.env
and add the secrets. -
Then Ctrl + Shift + P and select
Dev Containers: Rebuild Container
-
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. -
Run
make migrations
in terminal to create new migratrions. -
Run
make migrate
in terminal to migrate changes in the database. -
Run
make sync_roles
in terminal to add user roles in the database. -
Run
make dev
in terminal to run django.
- Duplicate
.env.template
and rename it to.env
, then add the necessary secrets. Ensure that the value of theDJANGO_ENV
environment variable is set toproduction
. - 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.