Development Setup

A Makefile is available to simplify repetitive actions and tasks as part of this development workflow.

Before setting up the development environment, ensure you have the following installed:

• Docker
• Git
• Python 3.10.x
• uv

Install the package manager

If you do not have uv installed, install it using the official installer:

curl -LsSf https://astral.sh/uv/install.sh | sh

For other installation methods, refer to the uv documentation.

Virtual Environment

Create and activate a virtual environment using uv:

uv venv .venv --python 3.10
source .venv/bin/activate
uv sync --all-extras --dev --frozen
uv sync --group docs  # If you want to create the documentation

This command will:

• Install all production dependencies
• Install development dependencies (testing, linting, etc.)
• Install documentation dependencies (mkdocs, mkdocs-material)
• Lock dependencies to ensure reproducible builds

Database Setup

Initialize the database with migrations:

uv run python manage.py migrate
uv run python manage.py check

This command will:

• Create the SQLite database file (db.sqlite3) and apply all migrations to set up the database schema.
• Verify that the installation was successful.
• Check for any issues with your Django project configuration.

Next Steps

After completing the setup, proceed to Running the Application to start the development server.