How xerberuz/backend_faworki works
Project Type and Purpose
• This is a backend-only API service for the “FaWorKi” freelance-work platform. It follows a classic MVC (Model-View-Controller)-style layering but without a “View” layer, since it exposes JSON endpoints consumed by a frontend or mobile client.
• Its main responsibility is to authenticate users, manage user roles (SuperAdmin, Admin, Cliente, Trabajador), and provide CRUD operations on business entities via REST endpoints.
File Structure Analysis
• Top-level components:
• server.js & start-production.js – application entry points (development vs. production)
• config/ – database and connection-pool setup for Prisma
• prisma/ – schema.prisma and migration history for PostgreSQL
• models/ – business‐entity ORM definitions (Certificado, Cliente, Trabajador, SuperAdmin, Usuario)
• controllers/ – per‐role and per‐resource controller logic
• routes/ – route definitions tying URL paths to controllers
• middleware/ – request validation logic
• scripts/ – setup scripts (e.g., for Render deployment)
• env.example & render.yaml – environment configuration & deployment descriptors
• Pattern: incoming HTTP → router layer → validation middleware → controller → Prisma client (models) → PostgreSQL.
Key Architectural Elements from README
• Express.js web server
• Prisma ORM over PostgreSQL
• Environment variables handled via dotenv
• Nodemon for hot reload in dev
• CLI scripts for Prisma client generation and DB synchronization
a. Main Components to represent:
• API Gateway / HTTP Server (Express.js + Router module)
• Middleware layer (validation, auth if added)
• Controller layer (Admin, Auth, Cliente, SuperAdmin, Trabajador controllers)
• Service / ORM layer (Prisma Client configured via config/database.js & connection-pool.js)
• PostgreSQL Database (deployed e.g. on Render or another host)
• Auxiliary Scripts & Deployment (render.yaml, db setup scripts, start-production.js)
b. Relationships & Data Flows:
• Clients (Web/Mobile) → HTTP(S) → Express.js Router
• Router → Validation Middleware → Controller
• Controller → Prisma Client API → PostgreSQL
• Prisma migrations (prisma/schema.prisma + migration SQL) update DB schema
• Scripts (e.g., setup-render-db.js) invoked at deploy time to bootstrap DB
c. Architectural Patterns & Principles:
• Layered architecture (Presentation/API → Business logic → Data Access)
• Separation of concerns (routes vs controllers vs models)
• Configuration abstraction (config folder for environment-specific DB pools)
• Infrastructure as code (prisma migrations, render.yaml)
d. Key Technologies & Frameworks:
• Node.js + Express.js (server, routing)
• Prisma ORM (models, migrations, generated client)
• PostgreSQL (relational store)
• dotenv (environment management)
• pnpm / npm scripts (build, dev, production entry points)