Useful Scripts

This document provides an overview of commonly used scripts in the Gyrinx project.

Development Scripts

Formats all code in the project including Python, JavaScript, SCSS, and Django templates.

./scripts/fmt.sh

Runs the full test suite using Docker for database services.

./scripts/test.sh

Checks for any migration issues or conflicts.

./scripts/check_migrations.sh

Safely resets Django migration state to match the main branch. Useful when switching between branches with different migration histories.

./scripts/reset-migrations-to-main.sh

Checks if code formatting is correct without making changes.

./scripts/fmt-check.sh

These are Django management commands available through the manage command:

Sets up the development environment file (.env).

manage setupenv

Ensures a superuser exists for development.

manage ensuresuperuser

Loads Django fixtures with overwrite capability.

manage loaddata_overwrite <fixture_name>

Last updated 1 month ago