kevinveenbirkenbachandClaude Opus 4.7
605f29a2f8
Move the deploy router into the compose- domain prefix to match the rest of the local stack lifecycle (compose-up/down/exec/...). Reorder its block alphabetically between compose-down and compose-entity-purge to keep `make help` and the alphabetical-targets lint happy. Update every active call site: contributor docs, agent-iteration docs, role-level Administration/README/TODO files, the bundles README, the test-environment scripts, the in-repo deploy helpers and main.sh, and the server stage task. The two wildcard prose references (`make deploy-*` in CLAUDE.md and testing/playwright.md) become single `make compose-deploy` mentions since no other deploy-* target exists. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
3.7 KiB
Development Environment Setup 🛠️
Use the repository's real setup flow. The main source of truth is the Makefile.
Important:
- Some local development commands change host settings such as DNS, AppArmor, and IPv6.
- Some commands use
sudo. - Read the setup guides first if you are new to this environment.
- The local development workflow is mainly tested on Linux.
Platform-Specific Instructions 🖥️
Shared Repository Workflow 🔄
These steps are the shared repository workflow and apply regardless of whether you work on Linux, macOS, or Windows with WSL2.
Bootstrap 🚀
Run these commands from the repository root:
make bootstrap
make environment-bootstrap
make compose-up
make network-trust-ca
Bootstrap Commands 📋
| Phase | Command | What it does |
|---|---|---|
| Initial setup | make bootstrap |
Installs project dependencies and runs the first repository setup. |
| Host preparation | make environment-bootstrap |
Prepares the local development machine for the project workflow. |
| Start stack | make compose-up |
Starts the local development stack. |
| Browser trust | make network-trust-ca |
Trusts the generated local CA so *.infinito.example works correctly in your browser. |
The pre-commit hooks are installed automatically by make environment-bootstrap.
Per-machine overrides go into the process environment before invoking make (e.g. export INFINITO_FOO=…); make dotenv honors caller-set values via setdefault semantics.
Teardown 🧹
When you are done, use these commands to stop the stack and clean up the local environment:
make compose-down
make environment-teardown
Teardown Commands 📋
| Phase | Command | What it does |
|---|---|---|
| Stop stack | make compose-down |
Stops the local development stack. |
| Host cleanup | make environment-teardown |
Reverts local development environment changes where supported. |
Full Development Flow 🔁
The repository already contains a modular environment test suite at scripts/tests/environment/. The commands from that suite are explained here as the intended end-to-end flow.
Flow Summary 📋
| Step | Command | Purpose in this flow |
|---|---|---|
| 1 | make install |
Installs the dependencies needed before running the local development flow. |
| 2 | make environment-bootstrap |
Prepares the host machine for local development. |
| 3 | make compose-up |
Starts the development stack. |
| 4 | make test |
Runs the main combined validation flow. |
| 5 | make compose-deploy mode=reinstall apps=web-app-matomo |
Runs the baseline validation path for one concrete app. For the retry-loop policy, see Role Loop. |
| 6 | make network-trust-ca |
Makes the generated local certificates trusted by the host browser. |
| 7 | make compose-down |
Stops the running development stack. |
| 8 | make environment-teardown |
Cleans up host-side development environment changes. |
Use this as a practical reference when you want to understand how local development is expected to work.
Minimal Hardware Resources 💾
If you work on a machine with limited CPU, RAM, or disk space, use the guide at hardware.md. The public article with the same topic is here.
For local deploy shortcuts and end-to-end checks, see testing.md.