How ajay-kumawat1/clg-project works
Project type and purpose
• This is a Node.js-based RESTful API service for user authentication and user-management, backed by MongoDB.
• It exposes endpoints under /auth and /user, handles JWT validation (Auth0), and sends transactional emails.
File structure
• Top-level:
• package.json / tsconfig.json – defines Node.js, TypeScript, and dependencies.
• src/app.ts – Express application entry point.
• src/config – config loader and database connector.
• src/routes – route definitions (auth.routes.ts, user.route.ts, index.ts).
• src/controllers – HTTP handlers for each resource.
• src/services / src/managers / src/factories – layered business logic (Service→Manager→Factory).
• src/models – Mongoose user schema.
• src/common – shared enums, interfaces, middleware (JWT verifier, Auth0 secret loader).
• src/utils – logging, mailing utilities.
README for additional insights
• Relies on MongoDB Atlas (cloud) and Mongo tools locally.
• Environment config via .env (Auth0 secrets, DB URI).
• Development server runs on port 5000.
a. Main components
• Clients (Web or Mobile apps)
• API Layer (Express + Middleware)
• Business Logic Layer (Controllers → Services → Managers → Factories)
• Data Layer (Models → MongoDB Atlas)
• External Services (Auth0 JWT secret provider, SMTP/email)
b. Relationships & interactions
• Clients → HTTP request → Express routes
• Routes → Controllers → Services → Managers → Factories
• Factories → Models → MongoDB
• Middleware (JWT validation) intercepts requests → Auth0
• Services call utils.sendMail to notify users
c. Architectural patterns & principles
• Layered architecture (clear separation: routing, business, data)
• Dependency injection via factories
• Middleware chain for cross-cutting concerns (logging, auth)
d. Key technologies
• Node.js + Express + TypeScript
• Mongoose for ODM
• Auth0 JWT (express-jwt + JWKS)
• MongoDB Atlas
• nodemailer (or similar) via utils/sendMail