How sunbird-all/all-orchestration-service works
Project type and purpose
• This is a backend orchestration service written in Node.js/TypeScript.
• It exposes REST APIs (via Express in index.ts) and coordinates data access across two persistence layers: MongoDB and a relational database.
• It’s packaged as a single container (Dockerfile + docker-compose), but internally split into two logical modules (mongo_module and sql_module).
File structure
• Top-level:
• index.ts – the Express app entry point
• Dockerfile / docker-compose.yml – container build & orchestration
• package.json, tsconfig.json, ESLint, GitHub workflows
• src/common – shared utilities: cacheManager, generic CRUD, HTTP Exception & Response wrappers
• src/mongo_module – domain models under mongoose, and modules organized by entity: each with its router, controller, service
• src/sql_module – relational schema definitions, data.config.ts, and modules (router/controller/service) parallel to mongo_module
README for additional insights
• Very minimal; confirms that “start server” runs nodemon on index.ts.
Final checklist for the principal software engineer
• Modules under one supernode labeled “Orchestration Service.”
• Internal layering (Router → Controller → Service → Model) twice—once for each data store.
• Docker build & compose context: one container for the service, two for DBs.