# chirag-varu/caam architecture

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

- Interactive diagram: https://gitdiagram.com/chirag-varu/caam
- Repository: https://github.com/chirag-varu/caam

## Overview

##### Main System Components

A. Client-Side (Frontend Layer)
- React-based frontend with distinct user interfaces for:
- Students (Admission, Dashboard, Fees, Grievance, etc.)
- HOD (Scholarship management, Leave approval)
- Super Admin (College management, Transactions)
- Document Admin
- Accountant Admin
- Marks Admin

B. Server-Side (Backend Layer)
- Express.js server with controllers and routes
- Authentication middleware
- File handling (Cloudinary integration)

C. Database Layer
- MongoDB with different collections (shown through models)

D. External Services
- Payment Gateway (Razorpay)
- Cloudinary (for document storage)

##### Component Relationships and Data Flow

**[Client Layer]**
- ↑↓
**[API Gateway/Authentication Layer]**
- ↑↓
**[Service Layer (Controllers)]**
- ↑↓
**[Data Access Layer (Models)]**
- ↑↓
**[Database Layer]**

##### Specific Implementation Details

a) Frontend Components (Blue):
- Student Portal (Dashboard, Admission, Fees, etc.)
- Admin Portals (Super Admin, HOD, Document, Accountant)
- Shared Components (Navbar, Forms)

b) Backend Services (Green):
- Authentication Controllers
- Resource Controllers (Student, College, Course, etc.)
- Payment Processing
- Document Management

c) Database Collections (Yellow):
- Student
- Admin
- College
- Course
- Transaction
- Scholarship
- Grievance
- Leave

d) External Services (Purple):
- Payment Gateway
- Cloud Storage

##### Key Interactions to Highlight

- Student Registration/Login Flow
- Admission Process Flow
- Fee Payment and Wallet Operations
- Document Verification Process
- Scholarship Application and Approval
- Grievance Filing and Resolution

##### Technical Specifications

- React + TypeScript frontend
- Express.js backend
- MongoDB database
- RESTful API endpoints
- JWT Authentication
- Cloudinary integration
- Razorpay payment gateway

##### Application Layer (Middle)
- API Gateway
- Authentication
- Business Logic
- Service Integration

##### Data Layer (Bottom)
- Database
- File Storage
- Caching (if implemented)

## Diagram (Mermaid)

```mermaid
graph TB
    %% Styles and Classes
    classDef frontend fill:#3498db,stroke:#2980b9,color:white
    classDef backend fill:#2ecc71,stroke:#27ae60,color:white
    classDef database fill:#f1c40f,stroke:#f39c12,color:black
    classDef external fill:#9b59b6,stroke:#8e44ad,color:white
    classDef api fill:#e74c3c,stroke:#c0392b,color:white

    %% Frontend Layer
    subgraph Frontend
        StudentPortal["Student Portal"]:::frontend
        HODPortal["HOD Portal"]:::frontend
        SuperAdminPortal["Super Admin Portal"]:::frontend
        DocAdminPortal["Document Admin Portal"]:::frontend
        AccountantPortal["Accountant Portal"]:::frontend
        MarksAdminPortal["Marks Admin Portal"]:::frontend

        %% Student Features
        AdmissionSystem["Admission System"]:::frontend
        FeeManagement["Fee Management"]:::frontend
        GrievanceSystem["Grievance System"]:::frontend
        ScholarshipMgmt["Scholarship Management"]:::frontend
        LeaveManagement["Leave Management"]:::frontend
    end

    %% Backend Layer
    subgraph Backend
        AuthMiddleware["Auth Middleware"]:::backend
        
        %% Controllers
        StudentController["Student Controller"]:::backend
        CollegeController["College Controller"]:::backend
        CourseController["Course Controller"]:::backend
        ScholarshipController["Scholarship Controller"]:::backend
        GrievanceController["Grievance Controller"]:::backend
        PaymentController["Payment Controller"]:::backend
        
        %% Auth Controllers
        StudentAuth["Student Auth"]:::backend
        AdminAuth["Admin Auth"]:::backend
    end

    %% Database Layer
    subgraph Database
        MongoDB[(MongoDB)]:::database
        StudentModel["Student Model"]:::database
        AdminModel["Admin Model"]:::database
        CollegeModel["College Model"]:::database
        CourseModel["Course Model"]:::database
        TransactionModel["Transaction Model"]:::database
        ScholarshipModel["Scholarship Model"]:::database
        GrievanceModel["Grievance Model"]:::database
        LeaveModel["Leave Model"]:::database
    end

    %% External Services
    CloudinaryService["Cloudinary Storage"]:::external
    RazorpayGateway["Razorpay Gateway"]:::external

    %% Relationships
    StudentPortal --> AuthMiddleware
    HODPortal --> AuthMiddleware
    SuperAdminPortal --> AuthMiddleware
    DocAdminPortal --> AuthMiddleware
    AccountantPortal --> AuthMiddleware
    MarksAdminPortal --> AuthMiddleware

    AuthMiddleware --> StudentAuth
    AuthMiddleware --> AdminAuth

    StudentAuth --> StudentController
    AdminAuth --> CollegeController

    StudentController --> StudentModel
    CollegeController --> CollegeModel
    CourseController --> CourseModel
    ScholarshipController --> ScholarshipModel
    GrievanceController --> GrievanceModel
    PaymentController --> TransactionModel

    StudentModel --> MongoDB
    AdminModel --> MongoDB
    CollegeModel --> MongoDB
    CourseModel --> MongoDB
    TransactionModel --> MongoDB
    ScholarshipModel --> MongoDB
    GrievanceModel --> MongoDB
    LeaveModel --> MongoDB

    PaymentController --> RazorpayGateway
    StudentController --> CloudinaryService

    %% Click Events
    click StudentPortal "https://github.com/Chirag-varu/CAAM/tree/main/client/src/pages/Student/"
    click HODPortal "https://github.com/Chirag-varu/CAAM/tree/main/client/src/pages/HOD/"
    click SuperAdminPortal "https://github.com/Chirag-varu/CAAM/tree/main/client/src/pages/SuperAdmin/"
    click DocAdminPortal "https://github.com/Chirag-varu/CAAM/tree/main/client/src/pages/DocAdmin/"
    click AccountantPortal "https://github.com/Chirag-varu/CAAM/tree/main/client/src/pages/AccountantAdmin/"
    click MarksAdminPortal "https://github.com/Chirag-varu/CAAM/tree/main/client/src/pages/MarksAdmin/"
    click AdmissionSystem "https://github.com/Chirag-varu/CAAM/tree/main/client/src/components/student-admission/"
    click FeeManagement "https://github.com/Chirag-varu/CAAM/blob/main/client/src/pages/Student/FeeStatus.tsx"
    click GrievanceSystem "https://github.com/Chirag-varu/CAAM/blob/main/client/src/pages/Student/Grievance.tsx"
    click ScholarshipMgmt "https://github.com/Chirag-varu/CAAM/blob/main/client/src/pages/Student/Scholarship.tsx"
    click LeaveManagement "https://github.com/Chirag-varu/CAAM/blob/main/client/src/pages/Student/Leave.tsx"
    click StudentAuth "https://github.com/Chirag-varu/CAAM/blob/main/server/src/controllers/auth.student.controller.js"
    click AdminAuth "https://github.com/Chirag-varu/CAAM/blob/main/server/src/controllers/auth.admin.controller.js"
    click AuthMiddleware "https://github.com/Chirag-varu/CAAM/blob/main/server/src/middleware/auth.middleware.js"
    click StudentController "https://github.com/Chirag-varu/CAAM/blob/main/server/src/controllers/student.controller.js"
    click CollegeController "https://github.com/Chirag-varu/CAAM/blob/main/server/src/controllers/college.controller.js"
    click CourseController "https://github.com/Chirag-varu/CAAM/blob/main/server/src/controllers/course.controller.js"
    click ScholarshipController "https://github.com/Chirag-varu/CAAM/blob/main/server/src/controllers/scholarship.controller.js"
    click GrievanceController "https://github.com/Chirag-varu/CAAM/blob/main/server/src/controllers/grievance.controller.js"
    click PaymentController "https://github.com/Chirag-varu/CAAM/blob/main/server/src/controllers/verifyPayment.controller.js"
    click StudentModel "https://github.com/Chirag-varu/CAAM/blob/main/server/src/models/Student.model.js"
    click AdminModel "https://github.com/Chirag-varu/CAAM/blob/main/server/src/models/Admin.model.js"
    click CollegeModel "https://github.com/Chirag-varu/CAAM/blob/main/server/src/models/College.model.js"
    click CourseModel "https://github.com/Chirag-varu/CAAM/blob/main/server/src/models/Course.model.js"
    click TransactionModel "https://github.com/Chirag-varu/CAAM/blob/main/server/src/models/Transaction.model.js"
    click ScholarshipModel "https://github.com/Chirag-varu/CAAM/blob/main/server/src/models/Scholarship.model.js"
    click GrievanceModel "https://github.com/Chirag-varu/CAAM/blob/main/server/src/models/Grievance.model.js"
    click LeaveModel "https://github.com/Chirag-varu/CAAM/blob/main/server/src/models/Leave.model.js"
    click MongoDB "https://github.com/Chirag-varu/CAAM/blob/main/server/src/lib/db.js"
    click CloudinaryService "https://github.com/Chirag-varu/CAAM/blob/main/server/src/lib/cloudinary.js"
```
