# idurar/mern-admin architecture

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

- Interactive diagram: https://gitdiagram.com/idurar/mern-admin
- Repository: https://github.com/idurar/mern-admin

## Overview

##### Project type and purpose
- This is a full-stack MERN (MongoDB, Express.js, React.js, Node.js) admin dashboard starter app with generic CRUD and JWT-based auth.
- Frontend: React + Ant Design + Redux (with thunk)
- Backend: Node.js + Express.js + Mongoose (MongoDB)

##### File structure
- Top-level:
- app.js / server.js – application entry points
- controllers/, models/, routes/ – classic MVC pattern on the server
- handlers/ – error-handling middleware
- public/uploads – file storage for uploads
- data/ – sample data loader scripts
- setup/ – one-time backend setup scripts
- frontend/ – complete React application with its own config, src/, public/
- Notice controllers are split into authController, adminController, clientController, leadController, productController, plus a generic crudController
- Frontend src/ is organized by features: components, forms, pages, modules, context (hooks + context API), redux (actions, reducers, selectors), router, service worker, utils, style

##### README for insights
- Confirms MERN + AntD + Redux, generic CRUD and auth modules, admin management
- Implies two servers at runtime: Node/Express API and React development server (or build artifact served by Express in production)
- Database: MongoDB Atlas

a. Main components
- Web Client (React Single Page App)
- HTTP API Server (Node.js + Express)
- Database (MongoDB)
- File Store (uploads in public/uploads)
- Third-party/Internal Services (e.g., MongoDB Atlas, possible external auth or analytics)
b. Relationships & data flow
1. Browser loads React frontend (served from its own dev server or from Express static middleware).
2. React Router dispatches client-side routes; Redux and Context manage state.
3. UI components call the API via request layer (frontend/src/request/request.js)
4. Express receives HTTP requests at /api/* or /auth/* (routes/api.js, routes/authApi.js)
5. Requests are handled by controllers (authController, crudController, etc.)
6. Controllers call models (Mongoose schemas) to read/write MongoDB
7. Responses flow back to React; state is updated; UI re-renders.
8. File uploads are written to public/uploads by Express (multer or similar) and stored on disk or cloud.
c. Architectural patterns
- Backend: MVC (Models, Views ≈ JSON responses, Controllers) + middleware chain + error handlers
- Frontend: Flux pattern via Redux + Context + Custom Hooks for data fetching and network status
- Generic CRUD module: reusable controllers, React components, context actions, Redux slices
- Auth flow: JWT tokens stored in cookies (auth.service.js + cookie.js), guarded routes (PrivateRoute, PublicRoute)
d. Key technologies
- Frontend: React, React-Redux, Redux-Thunk, @ant-design, CRACO, Babel, Webpack, React Router
- Backend: Node.js, Express, Mongoose, JSON Web Token, environment config (.variables.env), setup scripts
- Infrastructure: MongoDB Atlas, optional cloud hosting (DigitalOcean, etc.)

##### Detailed separation of components
- In the frontend container:
- Components, Forms, Modules, Hooks, Context, Redux store, Router
- In the backend container:
- Routes layer → Controllers layer → Models layer → Database
- Setup scripts and sample data loader as pre-deployment steps
- Static file serving subcomponent

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client Layer
    subgraph "Frontend: React SPA"
        style Frontend fill:#D0E8FF,stroke:#0366D6,stroke-width:2px
        FE_Index["index.jsx"]:::client
        FE_PublicHTML["index.html"]:::client
        FE_Components["UI Components"]:::client
        subgraph "State Manager"
            FE_Store["store.js & storePersist.js"]:::client
            FE_ReduxModules["redux modules (auth, crud, search)"]:::client
            FE_ContextHooks["context & hooks"]:::client
        end
        subgraph "Routing"
            FE_AppRouter["AppRouter.jsx"]:::client
            FE_PrivateRoute["PrivateRoute.jsx"]:::client
            FE_PublicRoute["PublicRoute.jsx"]:::client
        end
        subgraph "Network"
            FE_Request["request.js"]:::client
            FE_SuccessHandler["successHandler.js"]:::client
            FE_ErrorHandler["errorHandler.js"]:::client
            FE_CodeMessage["codeMessage.js"]:::client
        end
        FE_AuthService["auth.service.js & cookie.js"]:::client
        FE_Layouts["Dashboard & Crud Layouts"]:::client
        FE_Modules["CRUD Modules"]:::client
        FE_Pages["Page Components"]:::client
    end

    %% Server Layer
    subgraph "Backend: Express API"
        style Backend fill:#E6FFE6,stroke:#028A0F,stroke-width:2px
        BE_App["app.js / server.js"]:::server
        subgraph "Routes"
            BE_API_Routes["api.js"]:::server
            BE_Auth_Routes["authApi.js"]:::server
        end
        subgraph "Controllers"
            BE_AuthCtrl["authController.js"]:::server
            BE_AdminCtrl["adminController.js"]:::server
            BE_ClientCtrl["clientController.js"]:::server
            BE_LeadCtrl["leadController.js"]:::server
            BE_ProductCtrl["productController.js"]:::server
            BE_CRUDCtrl["crudController/index.js"]:::server
            BE_CRUDMethods["crudMethods.js"]:::server
        end
        subgraph "Models"
            BE_AdminModel["Admin.js"]:::server
            BE_ClientModel["Client.js"]:::server
            BE_LeadModel["Lead.js"]:::server
            BE_ProductModel["Product.js"]:::server
        end
        BE_ErrorHandlers["errorHandlers.js"]:::middleware
        BE_StaticUploads["public/uploads"]:::storage
        BE_DataLoader["load-sample-admin.js"]:::scripts
        BE_Setup["setup.js"]:::scripts
        BE_Env[".variables.env.tmp"]:::config
        BE_Cert["ca-certificate.crt"]:::config
    end

    %% Database Layer
    DB["MongoDB Atlas"]:::database

    %% Connections
    Browser["Browser"]:::external
    Browser -->|"loads index.html"| FE_PublicHTML
    FE_PublicHTML -->|"bootstraps React"| FE_Index
    FE_Index --> FE_Components
    FE_Components --> FE_Layouts
    FE_Layouts --> FE_Pages
    FE_Pages --> FE_Modules
    FE_Modules --> FE_ContextHooks
    FE_ContextHooks --> FE_Store
    FE_Store --> FE_ReduxModules
    FE_ReduxModules --> FE_Request
    FE_Request --> FE_AppRouter
    FE_AppRouter --> FE_PrivateRoute
    FE_AppRouter --> FE_PublicRoute
    FE_PrivateRoute --> FE_AuthService
    FE_Request -->|"HTTP/JSON"| BE_API_Routes
    FE_Request -->|"HTTP/JSON"| BE_Auth_Routes
    BE_App --> BE_API_Routes
    BE_App --> BE_Auth_Routes
    BE_API_Routes --> BE_AuthCtrl
    BE_API_Routes --> BE_CRUDCtrl
    BE_Auth_Routes --> BE_AuthCtrl
    BE_CRUDCtrl --> BE_CRUDMethods
    BE_AuthCtrl --> BE_ClientCtrl
    BE_ClientCtrl --> BE_ClientModel
    BE_AdminCtrl --> BE_AdminModel
    BE_LeadCtrl --> BE_LeadModel
    BE_ProductCtrl --> BE_ProductModel
    BE_CRUDMethods --> BE_AdminModel
    BE_CRUDMethods --> BE_ClientModel
    BE_CRUDMethods --> BE_LeadModel
    BE_CRUDMethods --> BE_ProductModel
    BE_AuthCtrl -->|"JWT Auth"| BE_ErrorHandlers
    BE_API_Routes --> BE_ErrorHandlers
    BE_Auth_Routes --> BE_ErrorHandlers
    BE_CRUDMethods --> DB
    BE_ClientModel --> DB
    BE_AdminModel --> DB
    BE_LeadModel --> DB
    BE_ProductModel --> DB
    BE_ErrorHandlers --> BE_StaticUploads
    BE_StaticUploads --> DB

    %% Click Events
    click FE_Index "https://github.com/idurar/mern-admin/blob/master/frontend/src/index.jsx"
    click FE_PublicHTML "https://github.com/idurar/mern-admin/blob/master/frontend/public/index.html"
    click FE_Components "https://github.com/idurar/mern-admin/tree/master/frontend/src/components"
    click FE_Store "https://github.com/idurar/mern-admin/blob/master/frontend/src/redux/store.js"
    click FE_Store "https://github.com/idurar/mern-admin/blob/master/frontend/src/redux/storePersist.js"
    click FE_ReduxModules "https://github.com/idurar/mern-admin/tree/master/frontend/src/redux/auth"
    click FE_ReduxModules "https://github.com/idurar/mern-admin/tree/master/frontend/src/redux/crud"
    click FE_ReduxModules "https://github.com/idurar/mern-admin/tree/master/frontend/src/redux/search"
    click FE_ContextHooks "https://github.com/idurar/mern-admin/tree/master/frontend/src/context/crud"
    click FE_ContextHooks "https://github.com/idurar/mern-admin/tree/master/frontend/src/hooks"
    click FE_AppRouter "https://github.com/idurar/mern-admin/blob/master/frontend/src/router/AppRouter.jsx"
    click FE_PrivateRoute "https://github.com/idurar/mern-admin/blob/master/frontend/src/router/PrivateRoute.jsx"
    click FE_PublicRoute "https://github.com/idurar/mern-admin/blob/master/frontend/src/router/PublicRoute.jsx"
    click FE_Request "https://github.com/idurar/mern-admin/blob/master/frontend/src/request/request.js"
    click FE_SuccessHandler "https://github.com/idurar/mern-admin/blob/master/frontend/src/request/successHandler.js"
    click FE_ErrorHandler "https://github.com/idurar/mern-admin/blob/master/frontend/src/request/errorHandler.js"
    click FE_CodeMessage "https://github.com/idurar/mern-admin/blob/master/frontend/src/request/codeMessage.js"
    click FE_AuthService "https://github.com/idurar/mern-admin/blob/master/frontend/src/auth/auth.service.js"
    click FE_AuthService "https://github.com/idurar/mern-admin/blob/master/frontend/src/auth/cookie.js"
    click FE_Layouts "https://github.com/idurar/mern-admin/tree/master/frontend/src/layout/DashboardLayout"
    click FE_Layouts "https://github.com/idurar/mern-admin/tree/master/frontend/src/layout/CrudLayout"
    click FE_Layouts "https://github.com/idurar/mern-admin/tree/master/frontend/src/layout/DefaultLayout"
    click FE_Modules "https://github.com/idurar/mern-admin/tree/master/frontend/src/modules/CrudModule"
    click FE_Modules "https://github.com/idurar/mern-admin/tree/master/frontend/src/modules/CustomCrudModule"
    click FE_Modules "https://github.com/idurar/mern-admin/tree/master/frontend/src/modules/AdminCrudModule"
    click FE_Pages "https://github.com/idurar/mern-admin/blob/master/frontend/src/pages/Login.jsx"
    click FE_Pages "https://github.com/idurar/mern-admin/blob/master/frontend/src/pages/Dashboard.jsx"
    click FE_Pages "https://github.com/idurar/mern-admin/blob/master/frontend/src/pages/Admin.jsx"
    click FE_Pages "https://github.com/idurar/mern-admin/blob/master/frontend/src/pages/Lead.jsx"
    click FE_Pages "https://github.com/idurar/mern-admin/blob/master/frontend/src/pages/Product.jsx"
    click FE_Pages "https://github.com/idurar/mern-admin/blob/master/frontend/src/pages/Customer.jsx"
    click BE_App "https://github.com/idurar/mern-admin/blob/master/app.js"
    click BE_App "https://github.com/idurar/mern-admin/blob/master/server.js"
    click BE_API_Routes "https://github.com/idurar/mern-admin/blob/master/routes/api.js"
    click BE_Auth_Routes "https://github.com/idurar/mern-admin/blob/master/routes/authApi.js"
    click BE_AuthCtrl "https://github.com/idurar/mern-admin/blob/master/controllers/authController.js"
    click BE_AdminCtrl "https://github.com/idurar/mern-admin/blob/master/controllers/adminController.js"
    click BE_ClientCtrl "https://github.com/idurar/mern-admin/blob/master/controllers/clientController.js"
    click BE_LeadCtrl "https://github.com/idurar/mern-admin/blob/master/controllers/leadController.js"
    click BE_ProductCtrl "https://github.com/idurar/mern-admin/blob/master/controllers/productController.js"
    click BE_CRUDCtrl "https://github.com/idurar/mern-admin/blob/master/controllers/crudController/index.js"
    click BE_CRUDMethods "https://github.com/idurar/mern-admin/blob/master/controllers/crudController/crudMethods.js"
    click BE_AdminModel "https://github.com/idurar/mern-admin/blob/master/models/Admin.js"
    click BE_ClientModel "https://github.com/idurar/mern-admin/blob/master/models/Client.js"
    click BE_LeadModel "https://github.com/idurar/mern-admin/blob/master/models/Lead.js"
    click BE_ProductModel "https://github.com/idurar/mern-admin/blob/master/models/Product.js"
    click BE_ErrorHandlers "https://github.com/idurar/mern-admin/blob/master/handlers/errorHandlers.js"
    click BE_StaticUploads "https://github.com/idurar/mern-admin/tree/master/public/uploads"
    click BE_DataLoader "https://github.com/idurar/mern-admin/blob/master/data/load-sample-admin.js"
    click BE_Setup "https://github.com/idurar/mern-admin/blob/master/setup/setup.js"
    click BE_Env "https://github.com/idurar/mern-admin/blob/master/.variables.env.tmp"
    click BE_Cert "https://github.com/idurar/mern-admin/blob/master/ca-certificate.crt"

    %% Styles
    classDef client fill:#E0F7FA,stroke:#006064,stroke-width:1px
    classDef server fill:#E8F5E9,stroke:#2E7D32,stroke-width:1px
    classDef database fill:#FFF3E0,stroke:#EF6C00,stroke-width:2px,stroke-dasharray: 5 5
    classDef middleware fill:#F5F5F5,stroke:#9E9E9E,stroke-width:1px
    classDef storage fill:#FFF3E0,stroke:#FFB300,stroke-width:1px
    classDef scripts fill:#E8EAF6,stroke:#3949AB,stroke-width:1px
    classDef config fill:#F3E5F5,stroke:#8E24AA,stroke-width:1px
    classDef external fill:#FFFFFF,stroke:#000000,stroke-width:1px,stroke-dasharray: 2 2
```
