# sarthak-248/summer_training- architecture

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

- Interactive diagram: https://gitdiagram.com/sarthak-248/summer_training-
- Repository: https://github.com/sarthak-248/summer_training-

## Overview

##### Project type and purpose
- This is a full-stack MERN (MongoDB, Express, React, Node) healthcare management system.
- It serves two user-roles (Patients & Doctors), supports appointment booking, real-time notifications via Socket.IO, secure payments (Razorpay), image storage (Cloudinary), email reminders (SendGrid), and AI-powered health analysis (Python ML modules).

##### File structure
- Top-level:
- api/ – Node.js/Express backend
- client/ – React/Vite frontend
- requirements.txt – Python dependencies for ML
- .env.example, package.json, README.md
- api/ sub-folders:
- config/ – external API keys (Cloudinary, Razorpay)
- controllers/ – route-level business logic (auth, doctor, patient, payment)
- models/ – Mongoose schemas (User, Doctor, Patient)
- routes/ – Express routers mapping endpoints to controllers
- middlewares/ – JWT authentication, file uploads (Multer+Cloudinary)
- ml/ – Python scripts for training and inference (train_model.py, model_predictor.py)
- uploads/ & CSV datasets
- reminderScheduler.js – Node scheduler for email reminders
- client/ sub-folders:
- src/components, layouts, pages – React UI components, route pages
- state management via Redux Toolkit
- styling via Tailwind CSS
- real-time updates via Socket.IO client
- Configuration: Vite, ESLint, Tailwind, Cloudinary, Razorpay, SendGrid, JWT, socket.io.

##### README for additional insights
- Describes dual-role workflows (Doctor vs Patient)
- Real-time flows: appointment notifications, payment confirmations
- ML features: OCR + health severity prediction
- Payment flow: create-order → checkout → webhook/verify → status tracking
- Reminder service: emails at 24hr and 1hr before appointments
- Deployment & build steps for both front- and back-end.

a. Main components:
- Frontend: React app (UI layer, Redux, Socket.IO Client, Razorpay Checkout)
- API Layer: Node.js/Express server
- Database: MongoDB (hosted, accessed via Mongoose)
- ML Service: Python scripts (invoked from Node or as separate microservice)
- Real-Time Bus: Socket.IO server (in Express)
- Scheduler: Node reminderScheduler module (cron or setTimeout patterns)
- External Services:
– Razorpay (Payment Gateway)
– Cloudinary (Image storage)
– SendGrid (Email service)
b. Relationships & data flows:
1. User (Doctor/Patient) → React app → HTTP(S) REST API (Express)
2. Express routes → Controllers → Models → MongoDB
3. Express emits/receives events via Socket.IO ↔ React client for live updates
4. Payment: Express ↔ Razorpay API → Webhook → Controller → DB → Client notification
5. File upload: Client → Express → Multer → Cloudinary → URL stored in DB
6. ML analysis: Controller calls Python model_predictor.py → returns health severity data
7. Scheduler: reminderScheduler reads upcoming appointments from DB → SendGrid API → email
c. Architectural patterns & principles:
- Layered architecture (Presentation, API, Business, Data Access)
- Modular controllers and routes for separation of concerns
- Asynchronous event-driven design for real-time notifications
- Externalizing configuration (12-factor principles via .env)
- Integration of a specialized ML component as a service
- React/Redux/Vite
- Express.js/Mongoose
- Socket.IO
- Python (scikit-learn, joblib)
- Razorpay, Cloudinary, SendGrid
- Cron-style scheduler (Node)

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Frontend Layer
    subgraph "Frontend (React)" 
        direction TB
        App["App.jsx"]:::frontend
        AppRoutes["AppRoutes.jsx"]:::frontend
        Main["main.jsx"]:::frontend
        IndexHTML["index.html"]:::frontend
        ReactPages["React Pages"]:::frontend
        ReactComponents["React Components"]:::frontend
        Layouts["Layouts"]:::frontend
        Tailwind["tailwind.config.js"]:::frontend
        ViteConfig["vite.config.js"]:::frontend
        ESLint[".eslintrc.cjs"]:::frontend
        PostCSS["postcss.config.js"]:::frontend
    end

    %% Backend Layer
    subgraph "Backend (Express API)"
        direction TB
        API["index.js"]:::backend
        subgraph "Controllers & Routes"
            direction TB
            AuthCtrl["authController.js"]:::backend
            AuthRoutes["authRoutes.js"]:::backend
            DoctorCtrl["doctorController.js"]:::backend
            DoctorRoutes["doctorRoutes.js"]:::backend
            PatientCtrl["patientController.js"]:::backend
            PatientRoutes["patientRoutes.js"]:::backend
            PaymentCtrl["paymentController.js"]:::backend
            PaymentRoutes["paymentRoutes.js"]:::backend
        end
        subgraph "Models"
            direction TB
            UserModel["User.js"]:::backend
            DoctorModel["Doctor.js"]:::backend
            PatientModel["Patient.js"]:::backend
        end
        subgraph "Middlewares"
            direction TB
            AuthMW["authMiddleware.js"]:::backend
            LocalMulter["localMulter.js"]:::backend
            CloudMulter["multerCloudinary.js"]:::backend
        end
        subgraph "Services & Utilities"
            direction TB
            CloudConfig["cloudinary.js"]:::backend
            RazorConfig["razorpay.js"]:::backend
            Reminder["reminderScheduler.js"]:::backend
            subgraph "ML Service"
                direction TB
                TrainModel["train_model.py"]:::backend
                Predictor["model_predictor.py"]:::backend
            end
            subgraph "Artifacts & Data"
                direction TB
                ModelJoblib["rf_model.joblib"]:::backend
                LabelEnc["label_encoder.joblib"]:::backend
                DatasetCSV["cbc_health_severity_dataset.csv"]:::backend
            end
        end
        Uploads["uploads/"]:::backend
    end

    %% Data Store
    DB((MongoDB)):::datastore

    %% External Services
    subgraph "External Services"
        direction TB
        Razorpay["Razorpay"]:::external
        Cloudinary["Cloudinary"]:::external
        SendGrid["SendGrid"]:::external
    end

    %% Root & Documentation
    Requirements["requirements.txt"]:::backend
    Readme["README.md"]:::backend
    EnvExample[".env.example"]:::backend
    PackageJSON["package.json"]:::backend
    PackageLock["package-lock.json"]:::backend

    %% Connections
    App -->|REST API| API
    AppRoutes -->|renders pages| ReactPages
    ReactPages -->|uses| ReactComponents
    App -->|wraps| Layouts
    API -->|uses| AuthCtrl
    API -->|routes| AuthRoutes
    API -->|uses| DoctorCtrl
    API -->|routes| DoctorRoutes
    API -->|uses| PatientCtrl
    API -->|routes| PatientRoutes
    API -->|uses| PaymentCtrl
    API -->|routes| PaymentRoutes
    AuthCtrl -->|DB operations| UserModel
    DoctorCtrl -->|DB operations| DoctorModel
    PatientCtrl -->|DB operations| PatientModel
    PaymentCtrl -->|DB operations| UserModel
    API -->|middleware| AuthMW
    API -->|middleware| LocalMulter
    API -->|middleware| CloudMulter
    LocalMulter -->|stores files| Uploads
    CloudMulter -->|uploads to| Cloudinary
    Cloudinary -->|returns URL| API
    API -->|invokes| Predictor
    Predictor -->|loads| ModelJoblib
    Predictor -->|uses| LabelEnc
    Predictor -->|predicts on| DatasetCSV
    API -->|schedules| Reminder
    Reminder -->|reads| UserModel
    Reminder -->|sends emails via| SendGrid
    API -->|connects| DB
    API -->|integrates| Razorpay
    Razorpay -->|webhook| API
    API -->|emits/receives| SocketIO[("Socket.IO Server")]:::backend
    App -->|socket events| SocketIO
    API -->|reads config| CloudConfig
    API -->|reads config| RazorConfig

    %% Root docs
    Requirements --> Predictor
    EnvExample --> API
    Readme --> App
    PackageJSON --> API
    PackageLock --> API

    %% Click Events
    click App "https://github.com/sarthak-248/summer_training-/blob/master/client/src/App.jsx"
    click AppRoutes "https://github.com/sarthak-248/summer_training-/blob/master/client/src/AppRoutes.jsx"
    click Main "https://github.com/sarthak-248/summer_training-/blob/master/client/src/main.jsx"
    click IndexHTML "https://github.com/sarthak-248/summer_training-/blob/master/client/index.html"
    click ReactPages "https://github.com/sarthak-248/summer_training-/tree/master/client/src/pages"
    click ReactComponents "https://github.com/sarthak-248/summer_training-/tree/master/client/src/components"
    click Layouts "https://github.com/sarthak-248/summer_training-/tree/master/client/src/layouts"
    click Tailwind "https://github.com/sarthak-248/summer_training-/blob/master/client/tailwind.config.js"
    click ViteConfig "https://github.com/sarthak-248/summer_training-/blob/master/client/vite.config.js"
    click ESLint "https://github.com/sarthak-248/summer_training-/blob/master/client/.eslintrc.cjs"
    click PostCSS "https://github.com/sarthak-248/summer_training-/blob/master/client/postcss.config.js"
    click API "https://github.com/sarthak-248/summer_training-/blob/master/api/index.js"
    click CloudConfig "https://github.com/sarthak-248/summer_training-/blob/master/api/config/cloudinary.js"
    click RazorConfig "https://github.com/sarthak-248/summer_training-/blob/master/api/config/razorpay.js"
    click AuthCtrl "https://github.com/sarthak-248/summer_training-/blob/master/api/controllers/authController.js"
    click AuthRoutes "https://github.com/sarthak-248/summer_training-/blob/master/api/routes/authRoutes.js"
    click DoctorCtrl "https://github.com/sarthak-248/summer_training-/blob/master/api/controllers/doctorController.js"
    click DoctorRoutes "https://github.com/sarthak-248/summer_training-/blob/master/api/routes/doctorRoutes.js"
    click PatientCtrl "https://github.com/sarthak-248/summer_training-/blob/master/api/controllers/patientController.js"
    click PatientRoutes "https://github.com/sarthak-248/summer_training-/blob/master/api/routes/patientRoutes.js"
    click PaymentCtrl "https://github.com/sarthak-248/summer_training-/blob/master/api/controllers/paymentController.js"
    click PaymentRoutes "https://github.com/sarthak-248/summer_training-/blob/master/api/routes/paymentRoutes.js"
    click UserModel "https://github.com/sarthak-248/summer_training-/blob/master/api/models/User.js"
    click DoctorModel "https://github.com/sarthak-248/summer_training-/blob/master/api/models/Doctor.js"
    click PatientModel "https://github.com/sarthak-248/summer_training-/blob/master/api/models/Patient.js"
    click AuthMW "https://github.com/sarthak-248/summer_training-/blob/master/api/middlewares/authMiddleware.js"
    click LocalMulter "https://github.com/sarthak-248/summer_training-/blob/master/api/middlewares/localMulter.js"
    click CloudMulter "https://github.com/sarthak-248/summer_training-/blob/master/api/middlewares/multerCloudinary.js"
    click Uploads "https://github.com/sarthak-248/summer_training-/tree/master/api/uploads/"
    click Reminder "https://github.com/sarthak-248/summer_training-/blob/master/api/reminderScheduler.js"
    click TrainModel "https://github.com/sarthak-248/summer_training-/blob/master/api/ml/train_model.py"
    click Predictor "https://github.com/sarthak-248/summer_training-/blob/master/api/ml/model_predictor.py"
    click ModelJoblib "https://github.com/sarthak-248/summer_training-/blob/master/api/rf_model.joblib"
    click LabelEnc "https://github.com/sarthak-248/summer_training-/blob/master/api/label_encoder.joblib"
    click DatasetCSV "https://github.com/sarthak-248/summer_training-/blob/master/api/cbc_health_severity_dataset.csv"
    click Requirements "https://github.com/sarthak-248/summer_training-/blob/master/requirements.txt"
    click Readme "https://github.com/sarthak-248/summer_training-/blob/master/README.md"
    click EnvExample "https://github.com/sarthak-248/summer_training-/blob/master/.env.example"
    click PackageJSON "https://github.com/sarthak-248/summer_training-/blob/master/package.json"
    click PackageLock "https://github.com/sarthak-248/summer_training-/blob/master/package-lock.json"

    %% Styles
    classDef frontend fill:#cce5ff,stroke:#004085,color:#004085;
    classDef backend fill:#d4edda,stroke:#155724,color:#155724;
    classDef external fill:#fff3cd,stroke:#856404,color:#856404;
    classDef datastore fill:#e2e3e5,stroke:#6c757d,color:#6c757d;
```
