How coderdojo/community-platform works
Project type and purpose
• Zen is a full-stack, microservice-based community platform for CoderDojo (a global network of free coding clubs).
• It consists of a JavaScript/Node.js backend split into multiple microservices, an AngularJS frontend, a ticketing/profile/search platform, two NodeBB-based forums, an ETL pipeline for data import, and integrations (e.g., Mozilla Open Badges).
File structure
• This repository is purely documentation (README.md, architecture.md, localisation.md, forums.md, etc.) plus supporting ETL scripts under scripts/zen-etl.
• The core application code lives in three separate microservice repos and one frontend repo (linked from architecture.md).
• The ETL folder includes dump creation, JS scripts to insert dojos/users, packaged with zen.etl.js.
Key insights from README
• The system runs as multiple Node.js services and an AngularJS client.
• Two forum services run on NodeBB.
• Data storage uses a relational database accessed by each microservice.
• There’s an external badge-issuing service (Mozilla Open Badges).
• There is a separate local dev environment repo (cp-local-development).
a. Main components
– Frontend (AngularJS SPA)
– API Gateway or aggregator (if present; otherwise direct service calls)
– Microservices (e.g., Dojo service, User service, Ticketing/service)
– Forums cluster (two NodeBB instances)
– Database (shared or per-service schemas)
– ETL pipeline (scripts/zen-etl)
– External services (Mozilla Open Badges API)
b. Relationships and interactions
– Frontend ↔ Microservices (REST/HTTP)
– Microservices ↔ Database (SQL queries, migrations)
– ETL → Database (initial data load)
– Frontend ↔ Forums (via widget or embedded URLs, API calls for auth)
– Services ↔ Open Badges (OAuth or API calls)
c. Architectural patterns/design principles
– Microservices: each service has its own bounded context (Dojo, User, Ticketing)
– Clear separation of concerns: frontend vs. backend vs. ETL vs. forums
– API-first design: all internal and external communications via HTTP APIs
– Documentation-driven: architecture.md as source of truth
d. Key technologies/frameworks
– Node.js for microservices
– AngularJS for frontend
– NodeBB for forums
– PostgreSQL/MySQL (or relational DB)
– JavaScript ETL scripts (zen.etl.js)
– Docker (in cp-local-development) for local dev
Detail without overcomplicating
• Every distinct component (microservices, forums, ETL, external).
• Integrations and data stores.
• Special configurations (e.g., migrations, Docker).