# siddhi2321/citizen_grivevance_system architecture

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

- Interactive diagram: https://gitdiagram.com/siddhi2321/citizen_grivevance_system
- Repository: https://github.com/siddhi2321/citizen_grivevance_system

## Overview

##### Project Type and Purpose
– This is a full-stack, role-based grievance redressal portal (“Citizens Grievance System”) with a React/Vite single-page application frontend and an Express/Node.js backend.
– It uses MongoDB for persistent storage, Cloudinary for file uploads, and an email service for notifications.

##### Main Architectural Layers
a. Client Layer (Frontend)
- React SPA built with Vite in `frontend/src/…`
- Components, pages (citizen/admin/officer), context (AuthContext), and hooks (useSession)
- API service abstraction in `frontend/src/services/api.js`
b. API Layer (Backend)
- Express.js server in `backend/index.js`
- Route definitions in `backend/routes/*.js` (auth, complaints, admin, officer, session, logout)
- Controllers in `backend/controllers/*.js` encapsulate business logic
- Middleware in `backend/middleware/*.js` enforces sessions and role-based access
c. Data Layer
- MongoDB collections via Mongoose models in `backend/models/*.js` (User, Officer, Admin, Complaint, OTP)
- DB connection boilerplate in `backend/connection/db.js`
d. Supporting Services
- File storage: Cloudinary integration in `backend/utils/cloudinary.js` (images are stored remotely)
- Email notifications: `backend/utils/sendEmail.js`
- Session persistence (via Express-session or JWT, implied by session controllers/middleware)

##### Component Interactions
– Browser/React → HTTP(S) requests → Express Routes → Controllers → Models → MongoDB
– Controllers handling file attachments call Cloudinary SDK, then store URLs in MongoDB
– Controllers triggering emails call `sendEmail.js` → external SMTP provider
– Session middleware validates tokens/cookies on each request

##### Architectural Patterns
– Layered (Presentation → API → Business Logic → Data)
– MVC-style split (Routes → Controllers → Models)
– RESTful resource design (e.g., POST /api/complaints, GET /api/complaints/:id)
– Role-based access control via middleware (requireSession, requireAdminSession, requireOfficer)

## Diagram (Mermaid)

```mermaid
graph TD
    %% Client Layer
    subgraph "Client Layer"
        direction TB
        Browser["Browser"]:::external
        subgraph "React SPA" 
            direction TB
            Main["main.jsx"]:::frontend
            AppComp["App.jsx"]:::frontend
            AuthContext["AuthContext.jsx"]:::frontend
            UseSession["useSession.tsx"]:::frontend
            APIService["api.js"]:::frontend
        end
    end

    Browser -->|"loads SPA"| Main
    Main -->|"renders"| AppComp
    AppComp -->|"uses AuthContext"| AuthContext
    AppComp -->|"uses Routes/Layout"| APIService
    AppComp -->|"hooks Sessions"| UseSession
    AppComp -->|"calls API"| APIService

    %% API Server
    subgraph "API Server (Express)" 
        direction TB
        subgraph "Routes Layer"
            direction TB
            AuthRoutes["authRoutes.js"]:::backend
            ComplainRoutes["complainRoutes.js"]:::backend
            AdminRoutes["adminRoutes.js"]:::backend
            OfficerRoutes["officerRoutes.js"]:::backend
            SessionRoutes["sessionRoutes.js"]:::backend
            LogoutRoute["logoutRoute.js"]:::backend
        end
        subgraph "Middleware Layer"
            direction TB
            ReqSession["requireSession.js"]:::backend
            ReqAdmin["requireAdminSession.js"]:::backend
            ReqOfficer["requireOfficer.js"]:::backend
            SessMiddleware["sessionMiddleware.js"]:::backend
        end
        subgraph "Controllers Layer"
            direction TB
            AuthCtrl["authController.js"]:::backend
            ComplaintsCtrl["complaintsController.js"]:::backend
            AdminCtrl["adminController.js"]:::backend
            OfficerCtrl["officerController.js"]:::backend
            OfficerDashCtrl["officerDashboardController.js"]:::backend
            SessionCtrl["sessionController.js"]:::backend
            ReopenCtrl["citizenReopenContoller.js"]:::backend
            LogoutCtrl["logout.js"]:::backend
        end
        subgraph "Models Layer"
            direction TB
            UserModel["user.js"]:::backend
            AdminModel["admin.js"]:::backend
            OfficerModel["officer.js"]:::backend
            ComplaintModel["complaint.js"]:::backend
            OTPModel["otp.js"]:::backend
        end
        DBConn["db.js"]:::backend
    end

    APIService -->|"HTTP requests"| AuthRoutes
    APIService --> ComplainRoutes
    APIService --> AdminRoutes
    APIService --> OfficerRoutes
    APIService --> SessionRoutes
    APIService --> LogoutRoute

    AuthRoutes -->|use| ReqSession
    ComplainRoutes -->|use| ReqSession
    AdminRoutes -->|use| ReqAdmin
    OfficerRoutes -->|use| ReqOfficer
    SessionRoutes -->|use| SessMiddleware

    AuthRoutes --> AuthCtrl
    ComplainRoutes --> ComplaintsCtrl
    AdminRoutes --> AdminCtrl
    OfficerRoutes --> OfficerCtrl
    OfficerRoutes --> OfficerDashCtrl
    SessionRoutes --> SessionCtrl
    ComplainRoutes --> ReopenCtrl
    LogoutRoute --> LogoutCtrl

    ControllersLayer --> ModelsLayer
    DBConn -->|connects| MongoDB

    %% Data Layer
    subgraph "Data Layer"
        MongoDB["MongoDB Cluster"]:::db
    end

    UserModel --> MongoDB
    AdminModel --> MongoDB
    OfficerModel --> MongoDB
    ComplaintModel --> MongoDB
    OTPModel --> MongoDB

    %% Supporting Services
    subgraph "Supporting Services"
        Cloudinary["Cloudinary"]:::external
        EmailService["Email Service"]:::external
    end

    ComplaintsCtrl -->|"upload/download"| Cloudinary
    ComplaintsCtrl -->|"send notifications"| EmailService

    %% Click Events
    click Main "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/frontend/src/main.jsx"
    click AppComp "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/frontend/src/App.jsx"
    click AuthContext "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/frontend/src/context/AuthContext.jsx"
    click UseSession "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/frontend/src/hooks/useSession.tsx"
    click APIService "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/frontend/src/services/api.js"
    click AuthRoutes "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/routes/authRoutes.js"
    click ComplainRoutes "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/routes/complainRoutes.js"
    click AdminRoutes "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/routes/adminRoutes.js"
    click OfficerRoutes "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/routes/officerRoutes.js"
    click SessionRoutes "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/routes/sessionRoutes.js"
    click LogoutRoute "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/routes/logoutRoute.js"
    click AuthCtrl "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/controllers/authController.js"
    click ComplaintsCtrl "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/controllers/complaintsController.js"
    click AdminCtrl "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/controllers/adminController.js"
    click OfficerCtrl "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/controllers/officerController.js"
    click OfficerDashCtrl "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/controllers/officerDashboardController.js"
    click SessionCtrl "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/controllers/sessionController.js"
    click ReopenCtrl "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/controllers/citizenReopenContoller.js"
    click LogoutCtrl "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/controllers/logout.js"
    click ReqSession "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/middleware/requireSession.js"
    click ReqAdmin "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/middleware/requireAdminSession.js"
    click ReqOfficer "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/middleware/requireOfficer.js"
    click SessMiddleware "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/middleware/sessionMiddleware.js"
    click UserModel "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/models/user.js"
    click AdminModel "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/models/admin.js"
    click OfficerModel "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/models/officer.js"
    click ComplaintModel "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/models/complaint.js"
    click OTPModel "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/models/otp.js"
    click DBConn "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/connection/db.js"
    click Cloudinary "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/utils/cloudinary.js"
    click EmailService "https://github.com/siddhi2321/citizen_grivevance_system/blob/main/backend/utils/sendEmail.js"

    %% Styles
    classDef frontend fill:#ADD8E6,stroke:#000,stroke-width:1px
    classDef backend fill:#90EE90,stroke:#000,stroke-width:1px
    classDef db fill:#FFA500,stroke:#000,stroke-width:1px
    classDef external fill:#D3D3D3,stroke:#000,stroke-width:1px
```
