# mohdsaadma07/arrive architecture

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

- Interactive diagram: https://gitdiagram.com/mohdsaadma07/arrive
- Repository: https://github.com/mohdsaadma07/arrive

## Overview

##### Project Type & Purpose
- Arrive is a full-stack MERN (MongoDB, Express, React, Node.js) web application for secure attendance tracking using facial recognition (face-api.js), geolocation (Leaflet), automated email alerts (Nodemailer/SMTP), and Firebase authentication.

##### Key Architectural Components
a. Frontend (React + face-api.js + Firebase Auth + Leaflet)
– Pages: Login, TeacherDashboard, StudentDashboard, AttendanceDashboard, AttendanceSummary, VerifyAttendance
– Services: authServices.js (wraps Firebase Auth), face recognition models in /public/models
– UI layer calls backend APIs via HTTP (axios/fetch)
b. Backend (Node.js + Express + JWT + Firebase Admin)
– Routes & Controllers:
- /api/users → userController
- /api/sessions → sessionController
- /api/attendance → attendanceController & attendanceSummary
– Middleware: authMiddleware (validates JWT / Firebase token)
– Services: firebaseAdmin.js (verifies Firebase tokens), mail.js (Nodemailer SMTP)
– Helpers: geo.js (calculates geolocation constraints)
c. Database & Storage
– MongoDB Atlas (Mongoose models: User, Session, Attendance)
– face-api.js model files served from client/public/models
d. External Services
– Firebase Authentication (OAuth + JWT issuance)
– SMTP Email Provider (Gmail/SMTP)
– Leaflet/OpenStreetMap for geolocation maps

##### Relationships & Data Flows
1) User opens React app → authenticates via Firebase Auth → receives JWT
2) Client calls Express API (/user, /session, /attendance) attaching JWT → authMiddleware verifies via firebaseAdmin
3) For marking attendance: React invokes face-api.js locally to capture & verify face → if success and within time/geofence (geo.js), calls /attendance → server saves record in MongoDB
4) Teachers generate sessions via /session → stored in DB → students fetch session list
5) attendanceSummary controller aggregates data → real-time dashboards update via polling or websockets (if implemented)
6) mail.js triggers SMTP email alerts when attendance thresholds fall below configured limits

##### Architectural Patterns & Principles
- Layered architecture:
- Presentation (React)
- Service/API (Express controllers + middleware + services)
- Data (MongoDB via Mongoose)
- Separation of concerns: face recognition and geolocation done client-side; business logic and persistence server-side
- JWT-based security with token validation middleware

## Diagram (Mermaid)

```mermaid
flowchart TB
    %% Client Layer
    subgraph "Client (React + face-api.js + Firebase Auth)" 
        style ClientLayer fill:#BBDEFB,stroke:#1976D2
        LoginPage["Login Page"] 
        TeacherDash["TeacherDashboard"] 
        StudentDash["StudentDashboard"] 
        AttendanceDash["AttendanceDashboard"] 
        AttendanceSummaryPage["AttendanceSummary Page"] 
        VerifyAttendancePage["VerifyAttendance Page"] 
        AuthService["authServices.js"] 
        FirebaseConfig["firebase.js"] 
        FaceModels["face-api.js Models"] 
        LeafletIntegration["Geolocation (Leaflet)"]
    end

    %% Server Layer
    subgraph "Server (Express + Controllers/Middleware/Services)"
        style ServerLayer fill:#C8E6C9,stroke:#388E3C
        UserRoutes["/api/users\nuserRoutes"] 
        SessionRoutes["/api/sessions\nsessionRoutes"] 
        AttendanceRoutes["/api/attendance\nattendanceRoutes"] 
        UserController["userController.js"] 
        SessionController["sessionController.js"] 
        AttendanceController["attendanceController.js"] 
        AttendanceSummaryController["attendanceSummary.js"] 
        AuthMiddleware["authMiddleware.js"] 
        FirebaseAdminService["firebaseAdmin.js"] 
        MailService["mail.js"] 
        GeoHelper["geo.js"] 
    end

    %% Data & External Services
    subgraph "Data & External Services"
        style DataLayer fill:#FFE0B2,stroke:#F57C00
        MongoDB["MongoDB Atlas"] 
        FirebaseAuth["Firebase Authentication"] 
        SMTP["SMTP Email Provider"] 
        LeafletOSM["Leaflet/OpenStreetMap"] 
    end

    %% Connections
    %% Auth Flow
    AuthService -->|uses Firebase SDK| FirebaseAuth
    VerifyAttendancePage -->|uses geolocation| LeafletIntegration
    LeafletIntegration -->|tiles| LeafletOSM

    %% Client to Server API calls
    LoginPage -->|HTTP/HTTPS, JWT| UserRoutes
    TeacherDash -->|HTTP/HTTPS, JWT| SessionRoutes
    StudentDash -->|HTTP/HTTPS, JWT| SessionRoutes
    AttendanceDash -->|HTTP/HTTPS, JWT| AttendanceRoutes
    AttendanceSummaryPage -->|HTTP/HTTPS, JWT| AttendanceRoutes
    VerifyAttendancePage -->|HTTP/HTTPS, JWT| AttendanceRoutes

    %% Server internal flow
    UserRoutes --> UserController
    SessionRoutes --> SessionController
    AttendanceRoutes --> AttendanceController
    AttendanceRoutes --> AttendanceSummaryController
    UserController --> AuthMiddleware
    SessionController --> AuthMiddleware
    AttendanceController --> AuthMiddleware

    AuthMiddleware --> FirebaseAdminService
    AttendanceController --> GeoHelper
    AttendanceController --> MongoDB
    AttendanceSummaryController --> MongoDB

    AttendanceController --> MailService
    MailService --> SMTP

    %% Data Persistence
    UserController --> MongoDB
    SessionController --> MongoDB

    %% Click events
    click LoginPage "https://github.com/mohdsaadma07/arrive/blob/main/client/src/Pages/Dashboard.jsx"
    click TeacherDash "https://github.com/mohdsaadma07/arrive/blob/main/client/src/Pages/TeacherDashboard.jsx"
    click StudentDash "https://github.com/mohdsaadma07/arrive/blob/main/client/src/Pages/StudentDashboard.jsx"
    click AttendanceDash "https://github.com/mohdsaadma07/arrive/blob/main/client/src/Pages/AttendanceDashboard.jsx"
    click AttendanceSummaryPage "https://github.com/mohdsaadma07/arrive/blob/main/client/src/Pages/AttendanceSummary.jsx"
    click VerifyAttendancePage "https://github.com/mohdsaadma07/arrive/blob/main/client/src/Pages/VerifyAttendance.jsx"
    click AuthService "https://github.com/mohdsaadma07/arrive/blob/main/client/src/services/authServices.js"
    click FirebaseConfig "https://github.com/mohdsaadma07/arrive/blob/main/client/firebase.js"
    click FaceModels "https://github.com/mohdsaadma07/arrive/tree/main/client/public/models"
    click VerifyAttendancePage "https://github.com/mohdsaadma07/arrive/blob/main/client/src/Pages/VerifyAttendance.jsx"
    click UserRoutes "https://github.com/mohdsaadma07/arrive/blob/main/server/routes/userRoutes.js"
    click SessionRoutes "https://github.com/mohdsaadma07/arrive/blob/main/server/routes/sessionRoutes.js"
    click AttendanceRoutes "https://github.com/mohdsaadma07/arrive/blob/main/server/routes/attendanceRoutes.js"
    click UserController "https://github.com/mohdsaadma07/arrive/blob/main/server/controllers/userController.js"
    click SessionController "https://github.com/mohdsaadma07/arrive/blob/main/server/controllers/sessionController.js"
    click AttendanceController "https://github.com/mohdsaadma07/arrive/blob/main/server/controllers/attendanceController.js"
    click AttendanceSummaryController "https://github.com/mohdsaadma07/arrive/blob/main/server/controllers/attendanceSummary.js"
    click AuthMiddleware "https://github.com/mohdsaadma07/arrive/blob/main/server/middleware/authMiddleware.js"
    click FirebaseAdminService "https://github.com/mohdsaadma07/arrive/blob/main/server/services/firebaseAdmin.js"
    click MailService "https://github.com/mohdsaadma07/arrive/blob/main/server/services/mail.js"
    click GeoHelper "https://github.com/mohdsaadma07/arrive/blob/main/server/helpers/geo.js"
    click MongoDB "https://github.com/mohdsaadma07/arrive/blob/main/server/models/userModel.js"
    click MongoDB "https://github.com/mohdsaadma07/arrive/blob/main/server/models/sessionModel.js"
    click MongoDB "https://github.com/mohdsaadma07/arrive/blob/main/server/models/attendance.js"

    %% Classes
    classDef frontend fill:#BBDEFB,stroke:#1976D2
    classDef backend fill:#C8E6C9,stroke:#388E3C
    classDef external fill:#FFE0B2,stroke:#F57C00

    class LoginPage,TeacherDash,StudentDash,AttendanceDash,AttendanceSummaryPage,VerifyAttendancePage,AuthService,FirebaseConfig,FaceModels,LeafletIntegration frontend
    class UserRoutes,SessionRoutes,AttendanceRoutes,UserController,SessionController,AttendanceController,AttendanceSummaryController,AuthMiddleware,FirebaseAdminService,MailService,GeoHelper backend
    class MongoDB,FirebaseAuth,SMTP,LeafletOSM external
```
