Development Workflow & Helper Scripts
Guidelines for daily development workflows, helper CLI scripts, and git conventions.
Helper CLI Scripts
MetaPilot provides dedicated CLI scripts under to streamline developer onboarding:
scripts/1. scripts/generate_fernet_key.py
scripts/generate_fernet_key.pyGenerates a valid 32 url-safe base64-encoded Fernet key:
bash
# Print key to stdout
python scripts/generate_fernet_key.py
# Write or update FERNET_KEY in services/api/.env
python scripts/generate_fernet_key.py --write-env
2. scripts/create_superadmin.py
scripts/create_superadmin.pyCreates a Super Admin user account in the database:
bash
# Interactive mode
python scripts/create_superadmin.py
# Command-line mode
python scripts/create_superadmin.py --email admin@example.com --password SecretPassword123
Alternatively run via Django management command:
bash
python manage.py create_superadmin --email admin@example.com --password SecretPassword123
3. scripts/backend.sh
scripts/backend.shLaunches the local Daphne ASGI backend server:
bash
./scripts/backend.sh
Git Branching & Pull Requests
- Branch Naming:
- (e.g.
feat/<topic>)feat/inbox-reactions - (e.g.
fix/<topic>)fix/fernet-dev-fallback - (e.g.
docs/<topic>)docs/architecture-lifecycle
- Commit Convention:
- Follow Conventional Commits:
<type>(<scope>): <summary>
- Follow Conventional Commits:
- Pull Request Checklist:
- All tests pass (&
python manage.py test).yarn lint - Documentation updated for modified/new endpoints or settings.
- All tests pass (