How tcc-fafram/backend works
Project Type and Purpose
• This is a backend‐only service (a RESTful API) written in Node.js/TypeScript.
• It exposes endpoints for managing courses, modules, lessons (aulas), users, roles (funções), exams (provas), completions, certificates, etc.
• It uses Express for routing, Prisma as the ORM for a relational database, and a layered architecture (Controller → Service → Repository).
File Structure
• Top‐level directory “backend” contains:
• package.json, tsconfig.json, Vitest config → TypeScript/Node setup
• prisma/schema.prisma + SQL triggers → database schema & migrations
• src/
– routers/…Router.ts → maps URLs to controllers
– controllers/…Controller.ts → HTTP request handling
– services/…Service.ts → business logic
– models/…Repository.ts → Prisma queries
– bases/BaseController, BaseService, BaseRepository → shared abstractions
– middleware/auth, exception, sessionUser → cross‐cutting concerns
– utils/app_error.ts → error modeling
– server.ts → app bootstrap
• src/test/… → unit/integration tests
README
• Minimal: refers to good‐practices doc.
a. Main Components
• API Gateway (Express Server)
• Routing Layer (Router modules)
• Controller Layer (Controllers orchestrating requests/responses)
• Service Layer (Business rules & transactions)
• Data Access Layer (Prisma Repositories)
• Relational Database (PostgreSQL/MySQL via Prisma)
• Cross‐Cutting Middleware (Auth, Session, Error Handling)
• Optional: External services (e.g., email/S3 if used later)
b. Relationships & Data Flow
1. Client → HTTP Request → Express Server
2. Express applies Middleware (auth check, sessionUser, exception catcher)
3. Router matching → invokes appropriate Controller
4. Controller extracts payloads, calls Service
5. Service invokes Repositories for CRUD via Prisma
6. Repository executes SQL on the Database
7. Prisma returns data → Service processes → Controller formats → Response to Client
c. Architectural Patterns & Principles
• Layered (Clean) Architecture: separation of concerns (routing, presentation, use‐cases, data)
• Dependency Injection (repositories/services wired in server.ts or via import)
• DRY / base classes for controllers, services, repositories
• Error‐First Middleware pattern
d. Key Technologies
• Node.js + TypeScript
• Express.js
• Prisma ORM
• Vitest (testing)
• SQL triggers (backend/prisma/sql)