mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2026-11-09 04:06:42 +00:00
kevinveenbirkenbach
da140094a1
Split docs/agents/action/iteration.md into role.md, playwright.md, workflow.md, and a scope-focused README. Move Certificate Authority and Inspect rules into role.md. Rewrite playwright.md as a machine- oriented state machine with explicit preconditions, procedure, exit gates, and escape path. Extract Playwright spec content MUSTs into the new contrib SPOT docs/contributing/artefact/files/role/playwright.specs.js.md. Reduce the agent-side spec and env.j2 pages to procedure only. Align the framework SPOT and the test-e2e-playwright role README with the central templates/package.json.j2 + files/playwright.config.js model and images.playwright.version as single source of truth. Sweep em dashes and sentence-case role headings across all touched docs per documentation.md and readme_md.md rules.
97 lines
4.2 KiB
Markdown
97 lines
4.2 KiB
Markdown
# Development Environment Setup 🛠️
|
|
|
|
Use the repository's real setup flow. The main source of truth is the [Makefile](../../../Makefile).
|
|
|
|
Important:
|
|
|
|
- Some local development commands change host settings such as [DNS](https://en.wikipedia.org/wiki/Domain_Name_System), [AppArmor](https://en.wikipedia.org/wiki/AppArmor), and [IPv6](https://en.wikipedia.org/wiki/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 🖥️
|
|
|
|
- [Linux](platform/linux.md)
|
|
- [macOS](platform/macos.md)
|
|
- [Windows (WSL2)](platform/windows-wsl2.md)
|
|
|
|
## 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:
|
|
|
|
```bash
|
|
make bootstrap
|
|
make environment-bootstrap
|
|
make up
|
|
make 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 up` | Starts the local development stack. |
|
|
| Browser trust | `make trust-ca` | Trusts the generated local [CA](https://en.wikipedia.org/wiki/Certificate_authority) so `*.infinito.example` works correctly in your browser. |
|
|
|
|
#### Optional Development Marker 🏷️
|
|
|
|
If you want to mark this checkout as a development environment, run:
|
|
|
|
```bash
|
|
make mark-development
|
|
```
|
|
|
|
This step is optional. It creates an empty `env.development` file in the repository root.
|
|
|
|
Several tools (e.g. `cli/deploy/development/compose.py`, `scripts/meta/resolve/apps.sh`) pass `env.ci` as the base env-file to Docker Compose and then, when `env.development` exists, append it as a second `--env-file`. Because Docker Compose applies env-files in order, any variable defined in `env.development` overrides the corresponding value from `env.ci`. This lets you customize local settings (ports, image tags, flags) without modifying the shared `env.ci` file.
|
|
|
|
The `pre-commit` hooks are installed automatically by `make environment-bootstrap` and do not depend on this marker.
|
|
|
|
### Teardown 🧹
|
|
|
|
When you are done, use these commands to stop the stack and clean up the local environment:
|
|
|
|
```bash
|
|
make down
|
|
make environment-teardown
|
|
```
|
|
|
|
#### Teardown Commands 📋
|
|
|
|
| Phase | Command | What it does |
|
|
|---|---|---|
|
|
| Stop stack | `make 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/](../../../scripts/tests/environment/README.md). 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 up` | Starts the development stack. |
|
|
| 4 | `make test` | Runs the main combined validation flow. |
|
|
| 5 | `make deploy-fresh-purged-apps APPS=web-app-matomo` | Runs the baseline validation path for one concrete app. For the retry-loop policy, see [Role Loop](../../agents/action/iteration/role.md). |
|
|
| 6 | `make trust-ca` | Makes the generated local certificates trusted by the host browser. |
|
|
| 7 | `make 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](hardware.md).
|
|
The public article with the same topic is [here](https://s.infinito.nexus/minpcdev).
|
|
|
|
For local deploy shortcuts and end-to-end checks, see [testing.md](../actions/testing.md).
|