# hetsuthar028/restaurant-app-wt architecture

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

- Interactive diagram: https://gitdiagram.com/hetsuthar028/restaurant-app-wt
- Repository: https://github.com/hetsuthar028/restaurant-app-wt

## Overview

##### Project type and purpose
- This is a full-stack MERN (MongoDB, Express, React, Node.js) web application called “Foodie – Restaurant App.”
- Purpose: Allow end users to browse, filter, and view menu items; allow admin users to add, edit, and delete menu items; support authentication, session management, image upload, i18n, pagination, and filtering.

##### File structure
- Top-level folders:
- client/ – React front-end
- server/ – Express/Node.js back-end
- screenshots/ – sample UI images
- client/: Contains public assets (i18n JSON files for multiple languages), React components organized by feature (auth, home, menu-item, navbar, etc.), routing, context, theming, and utility functions.
- server/: Contains Express entry point, middleware modules (authentication, validation, logging), route definitions, Mongoose models (Category, MenuItem, User), a job queue module, and utility modules (API errors, Redis client, session data).
- Configuration/build files: package.json in both client and server, .gitignore, README.md.

##### README for additional insights
- Confirms tech stack: React + MUI UI layer, Node.js + Express API layer, MongoDB for persistence, Redis for session caching, Firebase for image storage, JWT for auth tokens.
- Features: Admin menu management, user auth/authorization, OTP email verification, Google/Facebook sign-in, session management, soft deletes, error handling, i18n, pagination/filtering, logger middleware, file upload to Firebase.

##### Elements
- Clear labels: Name each component (e.g., “AuthRouter,” “MenuItemService,” “Redis Session Store”).
- UI → API (HTTP requests)
- API → DB/Cache (read/write)
- API → External services
- API → JobQueue → external or back into DB
- Rectangles for services
- Clouds for external services (Firebase, Google OAuth, SMTP)

##### Detailed breakdown
- “React App (i18n, MUI, context, router)”
- “Express App”
- Inside: Routers (auth, menu-items, categories, upload-image, otp), Middleware chain (validate-token, isSessionActive, user-validator, menu-item-validator), Error Handler
- “jobQueue” (background tasks)
- “ApiError, redisClient, sessionData”
- External (purple clouds):
- Firebase Storage
- Email/SMTP
- Google/Facebook OAuth endpoints
- Front-end → Express Routers
- Routers → Services → MongoDB/Redis
- Upload route → Firebase
- Auth routes ↔ OAuth providers
- OTP route → Email service
- Services → jobQueue → DB or external

## Diagram (Mermaid)

```mermaid
flowchart TD
  subgraph "Front-end"
    ReactApp["React App (i18n, MUI, context, router)"]:::frontend
    I18nLoader["i18n Loader"]:::frontend
    I18nAssets["i18n Assets Directory"]:::frontend
    Components["UI Components"]:::frontend
    Router["Client-side Router"]:::frontend
    Context["Application Context & Theming"]:::frontend
    Utils["Utility Functions"]:::frontend
  end

  subgraph "API Layer"
    Express["Express App"]:::backend

    subgraph "Routers & Middleware"
      AuthRouter["Auth Routers"]:::backend
      OTPRouter["OTP Router"]:::backend
      MenuRouter["Menu-Item Router"]:::backend
      CatRouter["Category Router"]:::backend
      UploadRouter["Upload Image Router"]:::backend
      ValidateToken["validate-token"]:::backend
      VerifyToken["verify-token"]:::backend
      SessionActive["isSessionActive"]:::backend
      AdminCheck["isAdmin"]:::backend
      MenuValidator["menu-item-validator"]:::backend
    end

    subgraph "Services & Utils"
      JobQueue["JobQueue Service"]:::backend
      SessionData["Session Data Util"]:::backend
      RedisClient["Redis Client"]:::backend
      ApiError["ApiError Utility"]:::backend
      ErrorHandler["Central Error Handler"]:::backend
      MenuModel["MenuItem Model"]:::backend
      CategoryModel["Category Model"]:::backend
      UserModel["User Model"]:::backend
    end
  end

  subgraph "Data Stores"
    Mongo["MongoDB"]:::database
    Redis["Redis"]:::database
  end

  subgraph "External Services"
    Firebase["Firebase Storage"]:::external
    EmailSrv["Email/SMTP Service"]:::external
    GoogleOAuth["Google OAuth"]:::external
    FacebookOAuth["Facebook OAuth"]:::external
  end

  %% Front-end to API
  ReactApp -->|"HTTPS Requests"| Express

  %% Front-end internal (context)
  ReactApp --> I18nLoader
  ReactApp --> Components
  ReactApp --> Router
  ReactApp --> Context
  ReactApp --> Utils
  I18nLoader --> I18nAssets

  %% API Routing and middleware
  Express --> AuthRouter
  Express --> OTPRouter
  Express --> MenuRouter
  Express --> CatRouter
  Express --> UploadRouter

  AuthRouter -->|uses| ValidateToken
  AuthRouter -->|uses| VerifyToken
  AuthRouter -->|uses| SessionActive
  AuthRouter -->|checks| AdminCheck
  AuthRouter -->|models| UserModel
  AuthRouter -->|"stores session"| SessionData
  AuthRouter -->|"caches session"| RedisClient
  AuthRouter -->|"calls"| GoogleOAuth
  AuthRouter -->|"calls"| FacebookOAuth

  OTPRouter -->|"sends OTP"| EmailSrv

  MenuRouter -->|uses| MenuValidator
  MenuRouter -->|models| MenuModel

  CatRouter -->|models| CategoryModel

  UploadRouter -->|"uploads"| Firebase
  UploadRouter -->|queues job| JobQueue

  %% Services & error handling
  Express -->|error pipe| ErrorHandler
  Express -->|throws| ApiError

  JobQueue --> Mongo
  JobQueue --> EmailSrv

  %% Data access
  MenuModel --> Mongo
  CategoryModel --> Mongo
  UserModel --> Mongo
  SessionData --> Redis
  RedisClient --> Redis

  %% Styles
  classDef frontend fill:#E3F2FD,stroke:#90CAF9
  classDef backend fill:#E8F5E9,stroke:#A5D6A7
  classDef database fill:#FFF3E0,stroke:#FFB74D
  classDef external fill:#F3E5F5,stroke:#CE93D8

  %% Click Events
  click ReactApp "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/client/src/App.js"
  click ReactApp "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/client/src/index.js"
  click I18nLoader "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/client/src/i18n.js"
  click I18nAssets "https://github.com/hetsuthar028/restaurant-app-wt/tree/master/client/public/assets/i18n"
  click Components "https://github.com/hetsuthar028/restaurant-app-wt/tree/master/client/src/components"
  click Router "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/client/src/router/AppRouter.js"
  click Context "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/client/src/AppContext.js"
  click Utils "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/client/src/utils/emailValidator.js"
  click Express "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/index.js"
  click AuthRouter "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/routes/user-auth-router.js"
  click OTPRouter "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/routes/otp-router.js"
  click MenuRouter "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/routes/menu-items-router.js"
  click CatRouter "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/routes/category-router.js"
  click UploadRouter "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/routes/upload-image-router.js"
  click ValidateToken "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/middlewares/validate-token.js"
  click VerifyToken "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/middlewares/verify-token.js"
  click SessionActive "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/middlewares/isSessionActive.js"
  click AdminCheck "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/middlewares/isAdmin.js"
  click MenuValidator "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/middlewares/menu-item-validator.js"
  click MenuModel "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/models/MenuItem.js"
  click CategoryModel "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/models/Category.js"
  click UserModel "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/models/User.js"
  click JobQueue "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/queue/jobQueue.js"
  click SessionData "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/util/sessionData.js"
  click RedisClient "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/util/redisClient.js"
  click ApiError "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/util/ApiError.js"
  click ErrorHandler "https://github.com/hetsuthar028/restaurant-app-wt/blob/master/server/src/error/apiErrorHandler.js"
```
