Engineering Space

Engineering Space

Purpose: Technical specifications, system architecture, database schemas, API maps, code guides, testing playbooks, and deployment procedures for building and maintaining Learnille.

---

🏛 Directory Navigation & Index

📐 Architecture

• Server-Side Architecture (NestJS Backend) - Deep architectural specification of the NestJS backend pipeline, domain modules, outbox queues, and wallet escrow.
• System Architecture Overview - High-level system architecture, service communication, and tech stack.
• System Architecture Diagram - Visual block diagrams and component breakdown.
• Data Models & ERD - Complete database entities, relations, and InstantDB schema.
• API Specifications - REST API standards, DTOs, Swagger documentation, and response wrappers.
• Architecture Decision Records (ADRs) - Historical architectural decisions (InstantDB, BullMQ, NestJS, MinIO).
• 🛠 Domain Codemaps:
  • Course Engine Codemap - Deep dive into course creation, section management, and video streaming.
  • Push Notification Codemap - Novu, Soketi, and push notification architecture.
  • Beacon Analytics Codemap & Beacon Analytics Spec - Student time tracking and analytics engine.
  • Consultation Lifecycle & Minimum Booking Notice Time.
  • Instructor Course Editor Wizard.
  • Wallet Withdrawal System.
  • Product Moderation Engine.
  • OpenSearch & Product Indexing & Migration Plan.

🗺 API Endpoint Map

• Master API Map - Comprehensive mapping of all NestJS server controllers, endpoints, guards, and Swagger tags.

💻 Development

• Dev Setup Guide - Local environment setup, PostgreSQL, Redis, InstantDB, and environment variables.
• Coding Standards & Conventions - Code style, enum usage, error handling, and strict typing.
• Version Control Policy - Git branching model, PR rules, and commit message conventions.

🧪 Testing & QA

• Test Strategy & Overview - Testing taxonomy (Unit, Integration, E2E).
• NestJS Real-E2E Playbook - Strict zero-mocking NestJS e2e testing playbook.
• Test Plan & Test Cases & Suites.
• Bug Report Template.

🚀 Deployment

• Deployment Guide - Production build & deployment procedures for server & frontend apps.