How arun12kumar/lead_management_system works
This is a backend-only Express.js REST API for an Insurance Lead Management System:
• HTTP API (Express) exposing endpoints for auth and lead lifecycle operations
• PostgreSQL persistence via Sequelize ORM
• JWT-based authentication
• Swagger UI for interactive API docs
• Conventional layering: Routes → Controllers → Services → Models/DB, with Middlewares for auth + validation and Migrations for schema management
Runtime entry + composition root
• src/server.js
The app bootstrap: creates the Express app, wires middleware, routes, swagger, logging, connects DB.
Configuration / integration components
• src/config/db.js
Sequelize init + Postgres connection (likely builds Sequelize instance using env vars)
• src/config/config.cjs
Sequelize CLI config per environment (used by migrations)
• src/config/swagger.js
Swagger spec setup and route mounting (e.g., /api/docs)
API surface (routing layer)
• src/routes/authRoute.js
• src/routes/leadRoutes.js
Endpoint paths, attach middlewares, forward to controllers.
Request handling (controller layer)
• src/controllers/authController.js
• src/controllers/leadController.js
Thin HTTP-focused handlers: parse request, call service, set status/response.
Business logic (service layer)
• src/services/leadService.js
Cross-cutting middleware
• src/middlewares/authMiddleware.js
JWT verification, request user context; protects routes.
• src/middlewares/leadValidators.js
Input validation for lead operations; fails fast before controller.
Persistence layer
• src/models/User.js
• src/models/Lead.js
Sequelize model definitions and associations (if any).
Schema management (not runtime critical, but architectural)
• src/migrations/*create-users.cjs, *create-leads.cjs
One-time / deploy-time schema evolution managed by Sequelize CLI.
Observability
• src/utils/logger.js
Winston logger; plus README mentions Morgan (HTTP access logs) likely wired in server.js.
Inbound
• Client (HTTP)
Express app pipeline (in server.js)
• Express Router mount points: /api/auth/*, /api/leads/*, /api/docs
• Global middleware: JSON parser, Morgan (if used), error handler (if present—if not, leave as “default error handling”)
Routes layer (src/routes)
• authRoute.js
• leadRoutes.js
Middleware layer (src/middlewares)
• authMiddleware.js (applies to protected lead routes)
• leadValidators.js (applies to create/update lead endpoints)
Controllers (src/controllers)
• authController.js
• leadController.js
Services (src/services)
• leadService.js
Persistence (src/models)
• User model
• Lead model
• Sequelize instance (from src/config/db.js)
Database
• PostgreSQL: tables users, leads (from migrations)
Docs + Config
• Swagger setup (src/config/swagger.js) feeding /api/docs
• Sequelize CLI config (src/config/config.cjs) used by migrations (show as “build/deploy-time” linkage, not runtime)
Logging
• src/utils/logger.js used by server/controllers/services
• Client → leadRoutes (e.g., POST /api/leads)
• leadRoutes → authMiddleware (Bearer token verification)
• leadRoutes → leadValidators
• leadRoutes → leadController
• leadController → leadService
• leadService → Lead model (Sequelize)
• Lead model → PostgreSQL (table: leads)
Auth flow:
• Client → authRoute (POST /api/auth/login)
• authRoute → authController
• authController → User model → PostgreSQL (users)
• authController → JWT signing (label “JWT_SECRET”)
• Response contains token → Client
Swagger flow:
• Client (browser) → /api/docs
• Express → Swagger UI/JSON (from swagger.js)
Migrations (separate lane):
• “Sequelize CLI (npm run migrate)” → src/migrations/*.cjs → PostgreSQL schema
Important architectural patterns to highlight
• Layered architecture: Routes (transport) → Controllers (HTTP concerns) → Services (business logic) → Models/ORM (data access)
• Middleware pipeline: Auth + validation executed before controllers
• Schema-as-code: migrations define DB evolution; README explicitly avoids sequelize.sync() in production
• Cross-cutting concerns:
• Security: JWT issuance + verification
• Observability: Morgan (request logs) + Winston logger
• API discoverability: Swagger docs served from same app
Split by lanes
• Runtime (Request Path)
• Data (Models + DB)
• Build/Deploy time (Migrations)
• Cross-cutting (Logging, Swagger)
• Protocol: HTTP/JSON, SQL
• Auth mechanism: “Bearer JWT”
• Key endpoints: /api/auth/login, /api/leads/*, /api/docs
*real* dependencies implied by the tree
• Routes depend on middlewares + controllers
• Controllers depend on services
• Services depend on models
• Models depend on Sequelize instance/config
• Migrations depend on Sequelize CLI config