How karimalisahili/gema_backend works
Project type and purpose
• This is a Node.js backend API written in TypeScript, using Express for HTTP routing, Drizzle ORM for database access, and PostgreSQL as the data store.
• The README confirms it exposes REST endpoints for managing users, technical locations, workgroups, technicians, and their relationships.
File structure
• Top‐level “src” folder holds all TS source code:
• src/index.ts – application entry point, creates Express app and verifies DB connection
• src/db.ts + drizzle.config.ts – configure and export Drizzle ORM instance pointing to PostgreSQL (DATABASE_URL)
• src/routes/index.ts – central router that mounts sub‐routers
• src/controllers/… – one folder per domain (auth, gruposDeTrabajo, tecnico, trabajaEnGrupo, ubicacionesTecnicas) each with controller, routes, service
• src/middleware/auth.middleware.ts – JWT or session‐based auth guard for protected endpoints
• src/tables/*.ts – Drizzle ORM table definitions (usuarios, grupoDeTrabajo, incluyen, trabajaEnGrupo, ubicacionTecnica)
• src/utils/password.ts – password hashing/verification
• src/scripts/*.ts – stand‐alone scripts (initDB, prepushdb, postpushdb, exportToExcel) that run migrations, seed data or export data
• src/swagger.ts – Swagger/OpenAPI setup for auto‐generated API docs
Key architecture points from README
• On server start: check DB connection → if OK, start listening on configured port
• “npm run pushdb” uses Drizzle to synchronize schema
• “npm run initDB” seeds a master user
Main components
a. External Client(s) (e.g. Frontend, Postman, other services)
b. Express HTTP Server
c. Middleware layer (auth.middleware)
d. Routing layer (src/routes)
f. Service layer (business logic services called by controllers)
g. ORM layer (Drizzle instance from src/db.ts)
h. Database (PostgreSQL) with tables: usuarios, grupoDeTrabajo, incluyen, trabajaEnGrupo, ubicacionTecnica
i. Utility modules (password utils)
j. Scripts & tools (initDB, pushdb, exportToExcel, Swagger)
Relationships and data flow
• HTTP Server → Authentication Middleware → Router
• Router → Domain‐specific Controller (e.g. AuthController, GrupoDeTrabajoController, etc.)
• Controller → Service (e.g. AuthService, GrupoDeTrabajoService)
• Service → Drizzle ORM → PostgreSQL
Architectural patterns & principles
• Layered architecture (presentation → controller → service → data)
• Separation of concerns: controllers handle HTTP/response, services handle business logic, ORM handles persistence
• Configuration via environment variables (DATABASE_URL in .env)
• Type safety end‐to‐end: TypeScript + Drizzle types + explicit request/response types in controllers
• DB schema migrations with Drizzle and init scripts