Building from source¶
| Module | Requirements | Build and test |
|---|---|---|
arnold-backend |
JDK 17, Maven 3.9 | mvn -f arnold-backend/pom.xml verify |
arnold-ui |
Node.js 22 | cd arnold-ui && npm ci && npm run lint && npm run test:deployment && npm run build |
arnold-runner |
Python 3.12, Node.js (for OpenCode) | cd arnold-runner && pip install -r requirements.txt pytest && pytest |
docs |
Python 3.12 | ./docs/serve.sh (see Writing docs) |
Repository layout¶
arnold/
├── arnold-backend/
│ ├── arnold-server/ # Dropwizard app, config/local.yml, Dockerfile, run.sh
│ ├── arnold-core/ # resources, services, providers, auth, runner dispatch, storage
│ └── arnold-models/ # request/response/document models
├── arnold-ui/ # Next.js app + Express server (server.js, auth.js), config/
├── arnold-runner/ # Python workflows (main.py, flows/, runner/), ci/ templates
├── deploy/ # compose support files: .env.example, aerospike/, ui/
├── docs/ # this site (Zensical)
└── docker-compose.yml
Running modules locally¶
Images¶
docker compose build builds all three images. Tagged releases (v*) build and push
ghcr.io/phonepe/arnold-{server,ui,runner} through .github/workflows/release.yml.
Contributing¶
See CONTRIBUTING.md: sign off commits (DCO), use
type(area|component): summary commit messages, keep builds green, and never commit secrets (gitleaks runs in
pre-commit and CI). Backend conventions are in
BACKEND.md.