How chirag-varu/caam works
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)