# ajay-kumawat1/clg-project architecture

> Architecture diagram of the GitHub repository ajay-kumawat1/clg-project, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-23). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ajay-kumawat1/clg-project
- Repository: https://github.com/ajay-kumawat1/clg-project

## Overview

##### 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

## Diagram (Mermaid)

```mermaid
flowchart TB
    classDef external fill:#eeeeee,stroke:#333,stroke-width:1px;
    classDef api fill:#bbdefb,stroke:#1e88e5,stroke-width:1px;
    classDef biz fill:#c8e6c9,stroke:#43a047,stroke-width:1px;
    classDef data fill:#fff9c4,stroke:#fdd835,stroke-width:1px;
    classDef ext fill:#f5f5f5,stroke:#9e9e9e,stroke-width:1px;

    Client["Client (Web/Mobile)"]:::external

    subgraph "Express API Layer"
        App["Express App"]:::api
        Config["Configuration Loader"]:::api
        DBConn["Database Connector"]:::api
    end

    subgraph "Routing & Middleware"
        Index["Routes Index"]:::api
        AuthRoutes["Auth Routes (/auth)"]:::api
        UserRoutes["User Routes (/user)"]:::api
        SecretMiddleware["Auth0 Secret Loader"]:::api
        JWTMiddleware["JWT Validation Middleware"]:::api
        UserAuth["User Authenticator Middleware"]:::api
        ReqMiddleware["Additional Request Middleware"]:::api
    end

    subgraph "Controllers"
        AuthCtrl["Authentication Controller"]:::api
        UserCtrl["User Controller"]:::api
    end

    subgraph "Business Logic"
        UserService["User Service"]:::biz
        UserManager["User Manager"]:::biz
    end

    subgraph "Data Access"
        UserFactory["User Factory"]:::data
        UserModel["User Model"]:::data
    end

    subgraph "External Services"
        Auth0Cloud["Auth0 (JWKS)"]:::ext
        EmailService["Email Service (SMTP)"]:::ext
        MongoDB["MongoDB Atlas"]:::data
    end

    Client -->|"HTTP Request (port 5000)"| App
    App --> Config
    App --> DBConn
    App --> Index

    Index --> AuthRoutes
    Index --> UserRoutes

    AuthRoutes --> SecretMiddleware
    AuthRoutes --> JWTMiddleware
    AuthRoutes --> UserAuth
    AuthRoutes --> ReqMiddleware
    AuthRoutes --> AuthCtrl

    UserRoutes --> SecretMiddleware
    UserRoutes --> JWTMiddleware
    UserRoutes --> UserAuth
    UserRoutes --> ReqMiddleware
    UserRoutes --> UserCtrl

    SecretMiddleware --> Auth0Cloud
    JWTMiddleware --> Auth0Cloud

    AuthCtrl --> UserService
    UserCtrl --> UserService

    UserService --> UserManager
    UserManager --> UserFactory
    UserFactory --> UserModel
    UserModel --> MongoDB
    UserService --> EmailService

    click App "https://github.com/ajay-kumawat1/clg-project/blob/main/src/app.ts"
    click Config "https://github.com/ajay-kumawat1/clg-project/blob/main/src/config/config.ts"
    click DBConn "https://github.com/ajay-kumawat1/clg-project/blob/main/src/config/database.ts"
    click AuthRoutes "https://github.com/ajay-kumawat1/clg-project/blob/main/src/routes/auth.routes.ts"
    click UserRoutes "https://github.com/ajay-kumawat1/clg-project/blob/main/src/routes/user.route.ts"
    click Index "https://github.com/ajay-kumawat1/clg-project/blob/main/src/routes/index.ts"
    click AuthCtrl "https://github.com/ajay-kumawat1/clg-project/blob/main/src/controllers/AuthController.ts"
    click UserCtrl "https://github.com/ajay-kumawat1/clg-project/blob/main/src/controllers/UserController.ts"
    click UserService "https://github.com/ajay-kumawat1/clg-project/blob/main/src/services/UserService.ts"
    click UserManager "https://github.com/ajay-kumawat1/clg-project/blob/main/src/managers/UserManager.ts"
    click UserFactory "https://github.com/ajay-kumawat1/clg-project/blob/main/src/factories/UserFactory.ts"
    click UserModel "https://github.com/ajay-kumawat1/clg-project/blob/main/src/models/User.ts"
    click JWTMiddleware "https://github.com/ajay-kumawat1/clg-project/blob/main/src/common/middleware/ValidAuth0Jwt.ts"
    click SecretMiddleware "https://github.com/ajay-kumawat1/clg-project/blob/main/src/common/middleware/expressJWTSecret.ts"
    click UserAuth "https://github.com/ajay-kumawat1/clg-project/blob/main/src/common/middleware/UserAuthenticator.ts"
    click ReqMiddleware "https://github.com/ajay-kumawat1/clg-project/blob/main/src/middlewares/user.middleware.ts"
    click EmailService "https://github.com/ajay-kumawat1/clg-project/blob/main/src/utils/sendMail.ts"
    click Config "https://github.com/ajay-kumawat1/clg-project/blob/main/src/utils/logger.ts"
    click Config "https://github.com/ajay-kumawat1/clg-project/blob/main/src/utils/common.ts"
    click Config "https://github.com/ajay-kumawat1/clg-project/blob/main/src/common/enum/Role.ts"
    click Config "https://github.com/ajay-kumawat1/clg-project/tree/main/src/common/interfaces"
    
    class Client external
    class App,Config,DBConn,Index,AuthRoutes,UserRoutes,SecretMiddleware,JWTMiddleware,UserAuth,ReqMiddleware,AuthCtrl,UserCtrl api
    class UserService,UserManager biz
    class UserFactory,UserModel,MongoDB data
    class Auth0Cloud,EmailService ext
```
