# abjabja/quickstart-mern-back-end architecture

> Architecture diagram of the GitHub repository abjabja/quickstart-mern-back-end, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-07-27). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/abjabja/quickstart-mern-back-end
- Repository: https://github.com/abjabja/quickstart-mern-back-end

## Overview

##### Project type and purpose
- This is a **backend-only** boilerplate for a MERN stack application (MongoDB, Express, Node.js).
- Its goal is to provide a quickstart template with modular user authentication (separating `auth_user` vs. `app_user` data), JWT-based sessions, validation, and a clean folder structure.

##### High-level architecture and components
- **Client (frontend or API consumer)**
- Sends HTTP requests to the Express server (e.g. register, login, hello world test).
- **Express Server (server.js)**
- Entry point. Loads environment variables, connects to MongoDB, wires up middleware and routes, and starts listening on `PORT`.
- **Middleware Layer**
- `authMiddleware.js` – parses and verifies JWT, attaches user context.
- `error-handler.js` – catches thrown errors and formats responses.
- `not-found.js` – handles unmatched routes.
- **Routing Layer (routes/…)**
- `authRoutes.js` – `/api/v1/auth/*` endpoints.
- `helloWorldRouter.js` – `/api/v1/hello` test endpoint.
- **Controller Layer (controllers/…)**
- `authController.js` – orchestrates register/login flows (calls authService).
- `helloWorldController.js` – simple GET handler.
- **Service Layer (services/authService.js)**
- Contains core business logic for registration, login, password hashing (bcryptjs), JWT issuing (jsonwebtoken), and validation (validator).
- **Data Access Layer (model/User.js + db/connect.js)**
- `connect.js` sets up Mongoose connection to MongoDB URI.
- `User.js` defines a Mongoose schema with two sub-schemas:
– `auth_user`: username, email, phone, hashed password
– `app_user`: freeform, customizable per application
- **Error Definitions (errors/…)**
- Custom Error classes (`BadRequest`, `NotFound`, `Unauthenticated`, etc.) to standardize error throwing and handling.

##### Interactions and data flow
1. Client → HTTP Request → Express (server.js)
2. Request → Middleware chain:
- Authentication (if endpoint requires JWT)
- Validation (e.g., input format checks)
- Error handler catch-all
3. Middleware → Router dispatch → Controller
4. Controller calls Service → Service uses Model to query/update DB
5. Service returns domain object or throws custom error
6. Controller → sends HTTP response → Client

##### Architectural patterns and principles
- **Layered (Onion) Architecture**: clear separation of concerns (Routing, Controllers, Services, Models)
- **Modular User Model**: two sub-schemas in one User model for auth vs. app data
- **Middleware Pipeline**: centralized error handling, JWT parsing
- **Dependency Injection (via imports)**: controllers import services; services import models

- Client / API Consumer
- Express Server
- Middleware Layer
- Router Layer
- Controller Layer
- Service Layer
- Data Access Layer (Mongoose)
- MongoDB Database
- External Dependencies (bcryptjs, jsonwebtoken, validator)
c. Patterns:
- Modular user schema sub-components
d. Technologies & libraries:
- Express.js, Mongoose, bcryptjs, jsonwebtoken, validator, Node.js

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    Client["Client / API Consumer"]:::client

    %% Server Entry Point
    Server["Express Server<br/>(server.js)"]:::layer
    click Server "https://github.com/abjabja/quickstart-mern-back-end/blob/main/server.js"

    %% Middleware Layer
    subgraph "Middleware Layer"
        direction TB
        AuthM["Authentication Middleware"]:::middleware
        click AuthM "https://github.com/abjabja/quickstart-mern-back-end/blob/main/middleware/authMiddleware.js"
        ErrM["Error Handler Middleware"]:::middleware
        click ErrM "https://github.com/abjabja/quickstart-mern-back-end/blob/main/middleware/error-handler.js"
        NotFoundM["Not-Found Handler Middleware"]:::middleware
        click NotFoundM "https://github.com/abjabja/quickstart-mern-back-end/blob/main/middleware/not-found.js"
    end

    %% Routing Layer
    subgraph "Routing Layer"
        direction TB
        AuthR["Auth Routes<br/>(/api/v1/auth)"]:::router
        click AuthR "https://github.com/abjabja/quickstart-mern-back-end/blob/main/routes/authRoutes.js"
        HelloR["Hello World Route<br/>(/api/v1/hello)"]:::router
        click HelloR "https://github.com/abjabja/quickstart-mern-back-end/blob/main/routes/helloWorldRouter.js"
    end

    %% Controller Layer
    subgraph "Controller Layer"
        direction TB
        AuthC["Auth Controller"]:::controller
        click AuthC "https://github.com/abjabja/quickstart-mern-back-end/blob/main/controllers/authController.js"
        HelloC["Hello World Controller"]:::controller
        click HelloC "https://github.com/abjabja/quickstart-mern-back-end/blob/main/controllers/helloWorldController.js"
    end

    %% Service Layer
    subgraph "Service Layer"
        direction TB
        AuthS["Auth Service"]:::service
        click AuthS "https://github.com/abjabja/quickstart-mern-back-end/blob/main/services/authService.js"
    end

    %% Data Access Layer
    subgraph "Data Access Layer"
        direction TB
        ConnectDB["MongoDB Connection Setup"]:::data
        click ConnectDB "https://github.com/abjabja/quickstart-mern-back-end/blob/main/db/connect.js"
        UserModel["User Model"]:::data
        click UserModel "https://github.com/abjabja/quickstart-mern-back-end/blob/main/model/User.js"
    end

    %% Error Definitions
    subgraph "Error Definitions"
        direction TB
        BadReq["BadRequest Error"]:::data
        click BadReq "https://github.com/abjabja/quickstart-mern-back-end/blob/main/errors/bad-request.js"
        NotFoundErr["NotFound Error"]:::data
        click NotFoundErr "https://github.com/abjabja/quickstart-mern-back-end/blob/main/errors/not-found.js"
        UnauthErr["Unauthenticated Error"]:::data
        click UnauthErr "https://github.com/abjabja/quickstart-mern-back-end/blob/main/errors/un-authenticated.js"
        APIErr["Custom API Error Base"]:::data
        click APIErr "https://github.com/abjabja/quickstart-mern-back-end/blob/main/errors/custom-api.js"
        ErrIndex["Error Exports Index"]:::data
        click ErrIndex "https://github.com/abjabja/quickstart-mern-back-end/blob/main/errors/index.js"
    end

    %% External Dependencies
    subgraph "External Dependencies"
        direction TB
        Bcrypt["bcryptjs"]:::ext
        JWT["jsonwebtoken"]:::ext
        Validator["validator"]:::ext
        Mongoose["mongoose"]:::ext
        ExpressLib["Express.js"]:::ext
    end

    %% Database
    MongoDB[(MongoDB)]:::db

    %% Flow Connections
    Client -->|HTTP Request| Server
    Server --> AuthM
    AuthM --> ErrM
    ErrM --> NotFoundM
    NotFoundM --> AuthR
    AuthR --> AuthC
    HelloR --> HelloC
    AuthC --> AuthS
    HelloC --> AuthS
    AuthS --> ConnectDB
    ConnectDB --> UserModel
    UserModel --> MongoDB
    MongoDB --> UserModel
    UserModel --> AuthS
    AuthS --> AuthC
    AuthC --> Server
    Server -->|HTTP Response| Client

    %% JWT Flow
    AuthC -->|issues JWT| JWT
    AuthM -->|verifies JWT| JWT

    %% Dependencies Usage
    AuthS --> Bcrypt
    AuthS --> JWT
    AuthS --> Validator
    UserModel --> Mongoose
    Server --> ExpressLib

    %% Styles
    classDef client fill:#b3e5fc,stroke:#000
    classDef middleware fill:#fff3e0,stroke:#000
    classDef router fill:#e8f5e9,stroke:#000
    classDef controller fill:#f3e5f5,stroke:#000
    classDef service fill:#e1f5fe,stroke:#000
    classDef data fill:#ffebee,stroke:#000
    classDef db fill:#c8e6c9,stroke:#000
    classDef ext fill:#f0f4c3,stroke:#000
```
