Skip to main content

Local Environment And Stack

Purpose​

  • This page gives contributors one place to bootstrap the Origo development stack and verify that the main developer tooling is working.

Required reading​

  • README.md
  • docs/docker-local-reference.md
  • docs/docker-local-env-reference.md

Process​

  1. Copy .env.example to .env and populate required values.
  2. Bootstrap the repo stack with scripts/s7_docker_stack.sh bootstrap.
  3. Sync Python dependencies for the relevant work area.
  4. Verify the API, control plane, and ClickHouse-dependent flows you need.
  5. If working on docs, run cd docs-site && npm ci && npm run build.

Checklist​

  • Root env file is present and non-empty for required values.
  • Python environment is synced for the affected workspace.
  • Local Docker stack starts cleanly.
  • At least one representative query or job path is verified.
  • docs-site build succeeds before publishing docs-only changes.

Failure cases and review notes​

  • Missing env vars are fail-loud by design across the API and control-plane surfaces.
  • If the local stack is unhealthy, do not paper over the problem with documentation claims.
  • docs/Developer/Tests-And-Gates.md
  • docs/Developer/Release-And-Deployment.md
  • control-plane/README.md