# denquinmaxence/brief--apimairie architecture

> Architecture diagram of the GitHub repository denquinmaxence/brief--apimairie, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-08-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/denquinmaxence/brief--apimairie
- Repository: https://github.com/denquinmaxence/brief--apimairie

## Overview

##### Project type and purpose
- This is a RESTful backend API (“Brief Api-Mairie”) written in Node.js + Express, using MongoDB as its data store.
- Its purpose is to allow authenticated users (and admins) to register/login, manage users and roles, define report categories, submit reports (with optional image uploads), and notify via email.

##### File structure
- Top-level: server.js (app entrypoint), package.json, Procfile (Heroku deploy), .env.example
- config/: DB connection (config/db.js) and initialization (config/init.js)
- routes/: express.Router definitions for each resource (/auth, /users, /roles, /reports, /reports/category)
- controllers/: handler functions implementing business logic for each route
- middleware/: authentication (isAuthenticated, isAdmin), request-body validation (checkBody*), file upload & Cloudinary integration, global index.js aggregator
- models/: Mongoose schemas for User, Role, ReportCategory, Report
- utils/: Multer setup (multipart parsing), email sending (sendEmail), generic validators (isValid)

##### Key insights from the README
- Standard CRUD endpoints per resource
- Authentication via JWT (login, logout, protected routes)
- File uploads stored on Cloudinary
- Email notifications sent on report creation
- Hosted on Heroku behind a Procfile

a. Main components
- Client (future UI or third-party consumers)
- HTTP(S) Load Balancer / API Gateway (Heroku Router)
- Express Application
– Routes Layer
– Middleware Pipeline
– Controllers (AuthController, UserController, RoleController, ReportController, ReportCategoryController)
– Utils (Multer, sendEmail)
- Data Layer
– MongoDB (Atlas or self-hosted)
– Cloudinary (image storage)
– SMTP/Email Service (e.g., Outlook, SendGrid)
- Configuration/Secrets (dotenv, .env)

b. Relationships and data flow
1. Client → HTTP(S) → Load Balancer → Express Routes
2. Routes → Validation & Auth Middleware
3. On file-upload routes: Multer parses multipart → Cloudinary middleware uploads image → Controller
4. Controller → Mongoose Model → MongoDB
5. On report creation: Controller → sendEmail util → External Email Service
6. Controller → Response → Client

c. Architectural patterns & design principles
- Layered MVC-inspired structure (Routes → Controllers → Models)
- Middleware chain for cross-cutting concerns (auth, validation, file handling)
- Single monolithic service hosted on Heroku
- Environment-driven configuration (12-factor app)
- Separation of concerns: controllers hold business logic, utils handle integrations

d. Key technologies
- Node.js + Express
- MongoDB + Mongoose
- JWT for authentication
- Multer & Cloudinary for file storage
- SMTP/External email for notifications
- dotenv for config, Heroku Procfile for deployment

##### Essential details to capture
- The JWT authentication flow (login endpoint issues token, protected endpoints require token via authMiddleware)
- Role‐based access control (isAdmin middleware guarding admin routes)
- File upload sequence (Multer → cloudinary.js middleware → ReportController)
- Email notification path (ReportController → utils/sendEmail → SMTP service)
- Database interaction (each controller calls corresponding Mongoose model)

## Diagram (Mermaid)

```mermaid
flowchart TD
    Client["Client"]:::external
    Client -->|HTTPS Request| Gateway["Heroku Router (API Gateway)"]:::external
    Gateway --> Entry["server.js"]:::internal

    subgraph "Configuration"
        Env[".env.example"]:::config
        Proc["Procfile"]:::config
        Package["package.json"]:::config
    end
    Entry --> Env
    Entry --> Proc
    Entry --> Package

    Entry --> DBConn["DB Connection (config/db.js)"]:::internal
    Entry --> Init["Initialization (config/init.js)"]:::internal

    subgraph "Express Application"
        direction TB
        subgraph "Routes Layer"
            AuthR["authRoutes"]:::internal
            UserR["userRoutes"]:::internal
            RoleR["roleRoutes"]:::internal
            ReportR["reportRoutes"]:::internal
            CatR["categoryReportRoutes"]:::internal
        end

        subgraph "Middleware Pipeline"
            IndexMW["index.js"]:::internal
            AuthMW["isAuthenticated"]:::internal
            AdminMW["isAdmin"]:::internal
            CBReport["checkBodyReport"]:::internal
            CBReportCat["checkBodyReportCategory"]:::internal
            CBRole["checkBodyRole"]:::internal
            CBSignUp["checkBodySignUp"]:::internal
            CloudMW["cloudinary"]:::internal
        end

        subgraph "Controllers"
            AuthC["AuthController"]:::internal
            UserC["UserController"]:::internal
            RoleC["RoleController"]:::internal
            ReportC["ReportController"]:::internal
            ReportCatC["ReportCategoryController"]:::internal
        end

        subgraph "Models"
            UserM["UserModel"]:::internal
            RoleM["RoleModel"]:::internal
            ReportM["ReportModel"]:::internal
            ReportCatM["ReportCategoryModel"]:::internal
        end

        subgraph "Utils"
            MulterU["multer"]:::internal
            SendEmailU["sendEmail"]:::internal
            IsValidU["isValid"]:::internal
        end
    end

    Entry --> AuthR
    Entry --> UserR
    Entry --> RoleR
    Entry --> ReportR
    Entry --> CatR

    AuthR --> IndexMW
    UserR --> IndexMW
    RoleR --> IndexMW
    ReportR --> IndexMW
    CatR --> IndexMW

    IndexMW --> AuthMW
    IndexMW --> AdminMW
    IndexMW --> CBReport
    IndexMW --> CBReportCat
    IndexMW --> CBRole
    IndexMW --> CBSignUp
    IndexMW --> CloudMW

    AuthR --> AuthC
    UserR --> UserC
    RoleR --> RoleC
    ReportR --> ReportC
    CatR --> ReportCatC

    AuthC --> UserM
    UserC --> UserM
    RoleC --> RoleM
    ReportC --> ReportM
    ReportCatC --> ReportCatM

    ReportC --> MulterU
    ReportC --> CloudMW
    ReportC --> SendEmailU

    DBConn --> DB["MongoDB"]:::db
    Init --> RoleM

    UserM --> DB
    RoleM --> DB
    ReportM --> DB
    ReportCatM --> DB

    SendEmailU --> Email["SMTP Service"]:::external
    CloudMW --> Cloudinary["Cloudinary"]:::db

    click Entry "https://github.com/denquinmaxence/brief--apimairie/blob/main/server.js"
    click Env "https://github.com/denquinmaxence/brief--apimairie/blob/main/.env.example"
    click Proc "https://github.com/denquinmaxence/brief--apimairie/tree/main/Procfile"
    click Package "https://github.com/denquinmaxence/brief--apimairie/blob/main/package.json"
    click DBConn "https://github.com/denquinmaxence/brief--apimairie/blob/main/config/db.js"
    click Init "https://github.com/denquinmaxence/brief--apimairie/blob/main/config/init.js"
    click AuthR "https://github.com/denquinmaxence/brief--apimairie/blob/main/routes/authRoutes.js"
    click UserR "https://github.com/denquinmaxence/brief--apimairie/blob/main/routes/userRoutes.js"
    click RoleR "https://github.com/denquinmaxence/brief--apimairie/blob/main/routes/roleRoutes.js"
    click ReportR "https://github.com/denquinmaxence/brief--apimairie/blob/main/routes/reportRoutes.js"
    click AuthC "https://github.com/denquinmaxence/brief--apimairie/blob/main/controllers/authController.js"
    click UserC "https://github.com/denquinmaxence/brief--apimairie/blob/main/controllers/userController.js"
    click RoleC "https://github.com/denquinmaxence/brief--apimairie/blob/main/controllers/roleController.js"
    click ReportC "https://github.com/denquinmaxence/brief--apimairie/blob/main/controllers/reportController.js"
    click ReportCatC "https://github.com/denquinmaxence/brief--apimairie/blob/main/controllers/reportCategoryController.js"
    click IndexMW "https://github.com/denquinmaxence/brief--apimairie/blob/main/middleware/index.js"
    click AuthMW "https://github.com/denquinmaxence/brief--apimairie/blob/main/middleware/isAuthenticated.js"
    click AdminMW "https://github.com/denquinmaxence/brief--apimairie/blob/main/middleware/isAdmin.js"
    click CBReport "https://github.com/denquinmaxence/brief--apimairie/blob/main/middleware/checkBodyReport.js"
    click CBReportCat "https://github.com/denquinmaxence/brief--apimairie/blob/main/middleware/checkBodyReportCategory.js"
    click CBRole "https://github.com/denquinmaxence/brief--apimairie/blob/main/middleware/checkBodyRole.js"
    click CBSignUp "https://github.com/denquinmaxence/brief--apimairie/blob/main/middleware/checkBodySignUp.js"
    click CloudMW "https://github.com/denquinmaxence/brief--apimairie/blob/main/middleware/cloudinary.js"
    click UserM "https://github.com/denquinmaxence/brief--apimairie/blob/main/models/userModel.js"
    click RoleM "https://github.com/denquinmaxence/brief--apimairie/blob/main/models/roleModel.js"
    click ReportM "https://github.com/denquinmaxence/brief--apimairie/blob/main/models/reportModel.js"
    click ReportCatM "https://github.com/denquinmaxence/brief--apimairie/blob/main/models/categoryReportModel.js"
    click MulterU "https://github.com/denquinmaxence/brief--apimairie/blob/main/utils/multer.js"
    click SendEmailU "https://github.com/denquinmaxence/brief--apimairie/blob/main/utils/sendEmail.js"
    click IsValidU "https://github.com/denquinmaxence/brief--apimairie/blob/main/utils/isValid.js"

    classDef internal fill:#cce5ff,stroke:#000
    classDef db fill:#d4edda,stroke:#000
    classDef external fill:#ffe5b4,stroke:#000
    classDef config fill:#e2e3e5,stroke:#000
```
