# pavilionryz/rms-in architecture

> Architecture diagram of the GitHub repository pavilionryz/rms-in, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-30). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pavilionryz/rms-in
- Repository: https://github.com/pavilionryz/rms-in

## Overview

##### Project type and purpose
- RestoMaster is a **full-stack MERN** (MongoDB, Express.js, React.js, Node.js) restaurant management system.
- It provides modules for authentication, order & cart management, menu & inventory tracking, staff & reservation management, payments, and analytics.

##### File structure
- **Backend/**
- Follows an **MVC**-style layout:
– models/ (Mongoose schemas)
– controllers/ (business logic per resource)
– routes/ (Express routers)
- middleware/ for auth, error handling
- utils/ for error handlers and user verification
- config/database.js for MongoDB connection
- server.js bootstraps Express
- seed.js populates initial data
- **Frontend/**
- React app built with Vite
- components/ organized into Auth, Layout, Pages, Loading, Redux, Storage
- Redux slices manage state for each domain (orders, cart, auth, etc.)
- setupInterceptors.jsx handles Axios interceptors (attach JWT, handle 401)
- ProtectedRoute wraps routes based on role/permission
- Storage/firebase.js for any Firebase interactions (e.g., OTP)

##### README for additional insights
- Uses JWT for authentication, Bcrypt for password hashing
- Tailwind CSS, Ant Design, Framer Motion on the front end
- Deployed on Vercel (frontend) and Render (backend)
- External services: MongoDB Atlas, SMTP email service, optional Firebase

a. Main components
- Client UI (browser/mobile)
- Frontend React app
- Redux Store
- HTTP Layer (Axios + Interceptors)
- Backend Node/Express API
- Controllers & Middlewares
- MongoDB database
- External services (SMTP email, Firebase Auth)
b. Relationships & interactions
1. **User flows**:
- User ⇒ React UI ⇒ Redux actions ⇒ Axios requests ⇒ Express routes ⇒ Controllers ⇒ Mongoose model ⇒ MongoDB
- Controllers may call utils (errorHandler, verifyUser) and middleware for auth & error catching
2. **Auth flow**:
- Login/Register ⇒ Controller ⇒ issue JWT ⇒ sent in response ⇒ stored in Redux ⇒ Axios interceptor attaches JWT to subsequent requests
3. **Real-time / updates**:
- Inventory/order changes saved in MongoDB ⇒ front end polls or re-fetches via Axios
4. **External integrations**:
- Email notifications via SMTP (configured in .env)
- OTP / password reset via Firebase
c. Architectural patterns
- **MVC** on backend
- **Flux/Redux** on frontend
- **Role-based access control** enforced in middleware & ProtectedRoute
- **Modularization**: separate slices/modules per domain
d. Key technologies
- Frontend: React, Redux, Tailwind CSS, Ant Design, Framer Motion, Axios
- Backend: Node.js, Express.js, Mongoose/MongoDB, JWT, Bcrypt
- External: MongoDB Atlas, SMTP email, Firebase, Vercel, Render

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Client/Presentation Tier
    subgraph "Client Tier"
        direction TB
        UI["React App"]:::frontend
        Store["Redux Store"]:::frontend
        subgraph "Redux Slices"
            direction TB
            AnalyticsSlice["analyticsSlice.js"]:::frontend
            AuthSlice["authSlice.js"]:::frontend
            CartSlice["cartSlice.js"]:::frontend
            InventorySlice["inventorySlice.js"]:::frontend
            MenuSlice["menuSlice.js"]:::frontend
            OrderSlice["orderSlice.js"]:::frontend
            PaymentSlice["paymentSlice.js"]:::frontend
            ReservationSlice["reservationSlice.js"]:::frontend
            StaffSlice["staffManagementSlice.js"]:::frontend
            UserSlice["userSlice.js"]:::frontend
        end
        Interceptor["Axios Interceptor"]:::frontend
        ProtectedRoute["ProtectedRoute"]:::frontend
        FirebaseStorage["Firebase Integration"]:::frontend
    end

    %% Server/Data Tier
    subgraph "Server Tier"
        direction TB
        Server["Express Server"]:::backend
        ConfigDB["DB Config"]:::backend
        subgraph "API Layer"
            direction TB
            Routes["Routes"]:::backend
            Controllers["Controllers"]:::backend
            Middleware["Middleware"]:::backend
        end
        subgraph "Business Utils"
            direction TB
            Utils["Utils"]:::backend
        end
        Seed["Seed Script"]:::backend
    end

    %% Database and External Services
    DB[("MongoDB")]:::database
    SMTP["SMTP Email Service"]:::external
    FirebaseAuth["Firebase Auth Service"]:::external

    %% Data Flow
    UI -->|"dispatches actions"| Store
    Store -->|"state change"| AnalyticsSlice
    Store -->|"state change"| AuthSlice
    Store -->|"state change"| CartSlice
    Store -->|"state change"| InventorySlice
    Store -->|"state change"| MenuSlice
    Store -->|"state change"| OrderSlice
    Store -->|"state change"| PaymentSlice
    Store -->|"state change"| ReservationSlice
    Store -->|"state change"| StaffSlice
    Store -->|"state change"| UserSlice
    Store -->|"triggers request"| Interceptor
    ProtectedRoute -->|"guards routes"| UI
    FirebaseStorage -->|"OTP/Password Reset"| UI

    Interceptor -->|"HTTP requests"| Server
    Server -->|"reads config"| ConfigDB
    Server -->|"uses routes"| Routes
    Routes -->|"calls"| Controllers
    Controllers -->|"checks auth"| Middleware
    Controllers -->|"utilizes"| Utils
    Controllers -->|"CRUD operations"| DB
    Seed -->|"populates"| DB

    DB -->|"responds data"| Controllers
    Controllers -->|"responses"| Interceptor
    Interceptor -->|"returns data"| UI

    UI -->|"sends email request"| SMTP
    UI -->|"uses OTP service"| FirebaseAuth

    %% Click Events
    click UI "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/App.jsx"
    click UI "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/index.html"
    click UI "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/main.jsx"
    click Store "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Store.js"
    click AnalyticsSlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/analyticsSlice.js"
    click AuthSlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/authSlice.js"
    click CartSlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/cartSlice.js"
    click InventorySlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/inventorySlice.js"
    click MenuSlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/menuSlice.js"
    click OrderSlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/orderSlice.js"
    click PaymentSlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/paymentSlice.js"
    click ReservationSlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/reservationSlice.js"
    click StaffSlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/staffManagementSlice.js"
    click UserSlice "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Redux/Slices/userSlice.js"
    click Interceptor "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/setupInterceptors.jsx"
    click ProtectedRoute "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/ProtectedRoute.jsx"
    click FirebaseStorage "https://github.com/pavilionryz/rms-in/blob/main/Frontend/src/components/Storage/firebase.js"
    click Server "https://github.com/pavilionryz/rms-in/blob/main/Backend/server.js"
    click ConfigDB "https://github.com/pavilionryz/rms-in/blob/main/Backend/config/database.js"
    click Utils "https://github.com/pavilionryz/rms-in/blob/main/Backend/utils/errorHandler.js"
    click Utils "https://github.com/pavilionryz/rms-in/blob/main/Backend/utils/verifyUser.js"
    click Seed "https://github.com/pavilionryz/rms-in/blob/main/Backend/seed.js"
    click Middleware "https://github.com/pavilionryz/rms-in/blob/main/Backend/middleware/authMiddleware.js"
    click Middleware "https://github.com/pavilionryz/rms-in/blob/main/Backend/middleware/error.js"
    click Middleware "https://github.com/pavilionryz/rms-in/blob/main/Backend/middleware/catchAsynError.js"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#004085,color:#004085
    classDef backend fill:#d4edda,stroke:#155724,color:#155724
    classDef database fill:#ffeeba,stroke:#856404,color:#856404
    classDef external fill:#f8d7da,stroke:#721c24,color:#721c24
```
