frogress/CONTRIBUTING.md

Contributing

Dependencies

• Python >=3.9
• Poetry

Setup

• Install Python dependencies with poetry

poetry install

• Set up the database

poetry run python manage.py migrate

• Start the API server

poetry run python manage.py runserver

Updating the database

If you modify any database models (models.py), you'll need to run the following to update the database:

poetry run python manage.py makemigrations
poetry run python manage.py migrate

Linting

poetry run mypy
poetry run black .