Backend Overview

This guide provides a quick orientation to the backend services and how their docs are organized.

Projects

• Web Backend (NestJS): REST API for the web app
  • Docs: Web Backend API
  • Related runtime: Shared SDK API
  • Shared types: Shared Types API
• Job Broker (microservice): background jobs and orchestration
  • Docs: Job Broker API
  • Related runtime: Shared SDK API
  • Shared types: Shared Types API
  • Solver Engine: SCRAM API

Tech stack

• NestJS 11.1.7
• Mongoose 8.19.2 for MongoDB
• TypeScript 5.9.3
• Nx 22.0.1 for orchestration; pnpm for package management

Conventions

• Modules, controllers, services live under src/ and are grouped by feature.
• Mongoose schemas live under src/schemas and are injected with MongooseModule.forFeature within feature modules.
• Routes are composed using RouterModule.register and mounted under /api/... paths; keep controller paths stable.
• DTOs and types come from packages/shared-types; runtime helpers live in packages/shared-sdk.
• Validation
  • Prefer the existing Zod validation pipe where applicable.

Links

• Web Backend API: ../api/ts/web-backend/README.html
• Job Broker API: ../api/ts/job-broker/README.html
• Shared SDK: ../api/ts/shared-sdk/README.html
• Shared Types: ../api/ts/shared-types/README.html