Developer Guide

This section covers local development: setup, the test suites, CI/CD, observability, and contribution conventions.

Pages

• Setup — local environment for both services and the docs.
• Testing — Python, Rails, and end-to-end suites.
• CI/CD — the GitHub Actions workflows.
• Observability — logging, tracing, and error tracking.
• Contributing — conventions and workflow.

The stack at a glance

services/     Python 3.14 FastAPI microservice (scans, scoring, AI)
rails_web/    Rails 8 web app (dashboard, jobs, internal API)
db/init/      Postgres init scripts
docs/         This Starlight documentation site
e2e/          Control-plane smoke test
.github/      CI/CD workflows

Quick commands

Task	Command
Start the stack	docker compose up --build
Python tests	cd services && .venv/bin/pytest -q
Rails tests	cd rails_web && bin/rails test
Tailwind build	cd rails_web && bin/rails tailwindcss:build
Docs dev server	cd docs && astro dev --background

Next

• Setup
• Testing