Skip to content

Maintenance

This page describes how to maintain the project. This includes running scripts, creating lockfiles, and running tests.

Scripts

There are several scripts that can be run directly from the command line. They can be run by running:

./scripts/<script_name>

Common scripts

  • ./scripts/dev - Starts a local development server on port 8000
  • ./scripts/docs - Builds and serves the documentation locally
  • ./scripts/docs-version - Updates the documentation version number to match the app version
  • ./scripts/makemigrations - Creates new migrations based on the changes made to the models
  • ./scripts/migrate - Applies the migrations to the database. See the migrations guide for more information.

Management

All Django / Wagtail management commands can be run using the manage.py script:

python manage.py <command>

For a complete list of commands, run:

python manage.py

Tests

Run the tests:

pytest

Lockfiles

Update the lockfile:

uv lock