Developer Guides

Practical guides for working with Noumaris platform.

Onboarding

New to Noumaris? Start here to get your development environment set up.

Clone repository
Install dependencies (Docker, Poetry, Node.js)
Start local services (PostgreSQL, Keycloak)
Configure Terraform for Keycloak
Run backend and frontend
Verify setup

Time to complete: ~30 minutes

Development

Building features? Learn the development workflow and best practices.

Running backend and frontend dev servers
Database migrations with Alembic
API testing (Swagger, Redoc, Postman)
Frontend development patterns
WebSocket debugging
Code quality tools

For: Day-to-day development tasks

Deployment

Shipping to production? Understand the deployment pipeline and infrastructure.

Google Cloud Build triggers
Cloud Run deployments (Canada + US regions)
Environment configuration
Database migrations in production
Keycloak theme deployment
Monitoring and logging

For: DevOps and production releases

Troubleshooting

Something broken? Common issues and solutions.

WebSocket connection failures
Keycloak authentication errors
Database migration issues
Docker/Terraform problems
Build and deployment failures

For: Debugging and fixing issues

Additional Resources

Architecture Overview - System design and structure
API Documentation - Complete API reference
ADRs - Why we made specific technical decisions