# nikhil-dadhich/role-based-e-commerce architecture

> Architecture diagram of the GitHub repository nikhil-dadhich/role-based-e-commerce, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-14). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/nikhil-dadhich/role-based-e-commerce
- Repository: https://github.com/nikhil-dadhich/role-based-e-commerce

## Overview

##### Project type and purpose
- This is a full-stack, role-based e-commerce platform built on Node.js/Express, MongoDB, and EJS.
- It supports Admin and Customer roles, product & order management, secure authentication, CSRF protection, PDF invoice generation, and email-based password reset.

##### File structure
- Top-level:
- app.js – Entry point, configures Express, middleware, routes, error handling
- package.json / package-lock.json – Dependencies & scripts
- Directories:
- controllers/ – Business logic per resource (admin, auth, shop, error)
- routes/ – URL endpoints mapping to controllers (admin.js, auth.js, shop.js)
- models/ – Mongoose schemas (User, Product, Order)
- middleware/ – Auth guards (is-auth), CSRF, error handlers
- util/ – Helpers (file operations, path resolution, PDF generation, email sending)
- public/ – Static assets: CSS, client-side JS, images
- views/ – EJS templates organized by feature (admin, auth, shop) plus shared includes
- data/ – Seed data & generated invoices (PDFs)
- images/ – Uploaded product images

##### Key insights from README
- MVC pattern, modular code.
- Tech stack: Express, MongoDB/Mongoose, EJS templating, pdfkit, nodemailer, bcrypt, csurf.
- Features: role-based access, sessions, CSRF tokens, PDF invoices, password reset via email.

- Client (Browser) with UI (EJS pages, static CSS/JS)
- Express Web Server (app.js)
- Middleware Layer (CSRF, session, auth guards)
- Routing Layer (routes/*.js)
- Controller Layer (controllers/*.js)
- Data Access Layer (models/*.js via Mongoose)
- MongoDB Database
- File Storage (local disk or S3) for product images & invoice PDFs
- External Email Service (via nodemailer SMTP)
- Utilities (PDF generation with pdfkit)

b. Relationships & data flows
1. Browser → HTTP Request → Express
2. Express → pass through Middleware (session, CSRF, is-auth)
3. Routing Layer dispatches → Controller
4. Controller uses Models → read/write MongoDB
5. Controller → render EJS view or send JSON
6. Invoice flow: Controller → PDF util → local file system (data/invoices) → serve download
7. Email flow: Controller → nodemailer util → SMTP server → user inbox
8. Static assets served directly from public/

c. Architectural patterns & design principles
- MVC (Model-View-Controller)
- Single Express process handling all routes
- Middleware pipeline for crosscutting concerns (auth, CSRF, error handling)
- Role-based access control via middleware & user model flags
- Separation of concerns: util helpers abstract file and email logic

d. Technologies & frameworks
- Node.js / Express.js
- MongoDB with Mongoose ODM
- EJS templating engine
- pdfkit for PDF generation
- nodemailer for SMTP email
- bcrypt for password hashing
- csurf for CSRF tokens
- express-session for session management

- Break the system into at least these components: UI, Web Server, Middleware, Routing, Controllers, Models, DB, File Store, External Services.
- Session & CSRF checks in the middleware layer.
- Role-guard paths: Admin vs Customer routes.
- PDF generation and email dispatch as separate utility sub-blocks.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    subgraph "Client Layer"
        direction TB
        EJS["EJS Templates"]:::webTier
        Static["Static Assets (CSS/JS/Images)"]:::webTier
    end

    %% Server Layer
    subgraph "Server Layer"
        direction TB
        Express["Express Web Server (app.js)"]:::appTier
        AuthMW["Auth Middleware (session, CSRF)"]:::appTier
        Routing["Routing Layer"]:::appTier
        subgraph "Routes"
            direction TB
            AdminRoute["Admin Routes"]:::appTier
            AuthRoute["Auth Routes"]:::appTier
            ShopRoute["Shop Routes"]:::appTier
        end
        Controller["Controller Layer"]:::appTier
        subgraph "Controllers"
            direction TB
            AdminCtrl["Admin Controller"]:::appTier
            AuthCtrl["Auth Controller"]:::appTier
            ShopCtrl["Shop Controller"]:::appTier
            ErrorCtrl["Error Controller"]:::appTier
        end
        Util["Utility Helpers"]:::appTier
        subgraph "Utils"
            direction TB
            FileUtil["File Operations"]:::appTier
            PathUtil["Path Resolution"]:::appTier
        end
    end

    %% Data Layer
    subgraph "Data Layer"
        direction TB
        ModelLayer["Data Access Layer"]:::dataTier
        subgraph "Models"
            direction TB
            UserModel["User Model"]:::dataTier
            ProductModel["Product Model"]:::dataTier
            OrderModel["Order Model"]:::dataTier
        end
        DB["MongoDB Database"]:::dataTier
        FileStore["File Storage"]:::dataTier
        subgraph "Storage"
            direction TB
            Images["Product Images"]:::dataTier
            Invoices["Invoice PDFs"]:::dataTier
        end
    end

    %% External Services
    subgraph "External Services"
        direction TB
        SMTP["SMTP Server (Nodemailer)"]:::external
    end

    %% Connections
    EJS -->|"Render Views"| Browser["Browser"]:::webTier
    Static -->|"Serve Static"| Browser
    Browser -->|"HTTP Request"| Express
    Express -->|"session, CSRF"| AuthMW
    AuthMW -->|"route dispatch"| Routing
    Routing -->|"/admin, /auth, /shop"| AdminRoute
    Routing -->|"/auth"| AuthRoute
    Routing -->|"/shop"| ShopRoute
    AdminRoute -->|"calls"| AdminCtrl
    AuthRoute -->|"calls"| AuthCtrl
    ShopRoute -->|"calls"| ShopCtrl
    Controller -->|"error handling"| ErrorCtrl
    AdminCtrl -->|"use models"| UserModel
    AuthCtrl -->|"use models"| UserModel
    ShopCtrl -->|"use models"| ProductModel
    ShopCtrl -->|"use models"| OrderModel
    UserModel -->|"read/write"| DB
    ProductModel -->|"read/write"| DB
    OrderModel -->|"read/write"| DB
    ShopCtrl -->|"generate PDF"| FileUtil
    FileUtil -->|"write file"| Invoices
    ShopCtrl -->|"send email"| SMTP

    %% Click Events
    click EJS "https://github.com/nikhil-dadhich/role-based-e-commerce/tree/main/views/"
    click Static "https://github.com/nikhil-dadhich/role-based-e-commerce/tree/main/public/"
    click Express "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/app.js"
    click AuthMW "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/middleware/is-auth.js"
    click AdminRoute "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/routes/admin.js"
    click AuthRoute "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/routes/auth.js"
    click ShopRoute "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/routes/shop.js"
    click AdminCtrl "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/controllers/admin.js"
    click AuthCtrl "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/controllers/auth.js"
    click ShopCtrl "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/controllers/shop.js"
    click ErrorCtrl "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/controllers/error.js"
    click UserModel "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/models/user.js"
    click ProductModel "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/models/product.js"
    click OrderModel "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/models/order.js"
    click FileUtil "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/util/file.js"
    click PathUtil "https://github.com/nikhil-dadhich/role-based-e-commerce/blob/main/util/path.js"
    click Images "https://github.com/nikhil-dadhich/role-based-e-commerce/tree/main/images/"
    click Invoices "https://github.com/nikhil-dadhich/role-based-e-commerce/tree/main/data/invoices/"

    %% Styles
    classDef webTier fill:#DEEBFF,stroke:#1F77B4
    classDef appTier fill:#E5F5E0,stroke:#2CA02C
    classDef dataTier fill:#FFE5CC,stroke:#FF7F0E
    classDef external fill:#EAD1DC,stroke:#9467BD
```
