Development¶

Guide for developing and contributing to the Orion platform.

Sections¶

Project Structure

Repository layout and conventions
Adding Services

How to create a new Python microservice
Testing

Testing strategies for Go, Python, and TypeScript
Code Style

Linting, formatting, and code conventions
Migrations

Database schema migrations with Alembic
Git Workflow

Branch strategy and commit conventions

Quick Reference¶

Build & Run¶

# Go
make build          # Build gateway + CLI
make run            # Run gateway locally
make test           # Run Go tests
make lint           # Run golangci-lint

# Python (per service)
cd services/scout
uv pip install -e ".[dev]"
uvicorn src.main:app --reload --port 8001

# Dashboard
cd dashboard
npm ci && npm run dev

# Docker (everything)
docker compose -f deploy/docker-compose.yml up -d

Common Tasks¶

Task	Command
Start all services	`docker compose -f deploy/docker-compose.yml up -d`
View logs	`docker compose -f deploy/docker-compose.yml logs -f scout`
Run Python tests	`cd services/scout && pytest`
Run Go tests	`make test`
Run dashboard tests	`cd dashboard && npm test`
Run migrations	`cd services/scout && alembic upgrade head`
Lint Python	`ruff check services/`
Lint Go	`make lint`