CONTRIBUTING.md

Contributing

We welcome all types of contributions, such as bug reports, ideas, design, testing, and code.

Development

To set up a development envoironment, first clone this project to your local development directory and change into the source directory.

Prerequisites

pipx

We recommend using pipx to install the development tools.

• https://pypa.github.io/pipx/installation/

Poetry

We currently use Poetry to manage project dependencies.

pipx install poetry

Pre-commit

We use pre-commit to run various code quality commands prior to each commit.

Install:

pipx install pre-commit

Activate (in the project directory):

pre-commit install

Install dependencies

Once you have the above prerequesites installed, install the project dependencies as follows.

poetry install

Activate virtual environment

Whenever you develop, make sure you are in the project virtual environment.

poetry shell

Migrations

When starting with an empty database or making changes to database models, be sure to make the migrations.

python manage.py makemigrations

When starting out the project or when there are unapplied migrations, apply the database migrations as follows.

python manage.py migrate

Create superuser

When starting out with an empty database, after applying migrations, create a superuser as follows.

python manage.py createsuperuser

Run the server

When all migrations are applied and you have a superuser, run the server as follows.

python manage.py runserver