# dhanushsaicoder/project-iris architecture

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

- Interactive diagram: https://gitdiagram.com/dhanushsaicoder/project-iris
- Repository: https://github.com/dhanushsaicoder/project-iris

## Overview

##### Project Type and Purpose
- This is a full-stack Progressive Web App (PWA) called **Project Iris**.
- It provides **real-time object detection** and **depth estimation** in the browser (using TensorFlow.js models) and records those sessions in a backend service for review and analytics.
- Admins can manage users and view overall session statistics via a React-based dashboard.

##### File Structure
- **/backend**
- Express server (server.js)
- Routes → Controllers → Models (MVC pattern)
- Auth, session and user management
- Uses Mongoose to persist to MongoDB
- **/frontend**
- React app bootstrapped with CRA + PWA template
- `/public/tfjs_models` serves TensorFlow.js models (fastDepth, COCO-SSD)
- `/src/components`, `/src/pages`, `/src/hooks`, `/src/context` → Component-based architecture + Context API for state
- `/src/workers/depth.worker.js` → Web Worker for heavy depth computation
- Service worker, PWA manifest
- **Root**
- install_all scripts, plan.md, project_context.md, testing_steps.md
- package.json orchestrates dev:mobile and proxy setups

##### README for Additional Insights
- **Tech Stack**
- Backend: Node.js + Express, MongoDB (Mongoose), JWT auth, bcrypt, CORS
- Frontend: React, Material-UI, Recharts, TensorFlow.js (COCO-SSD, fastDepth), Web Worker
- PWA capabilities, offline-first service worker
- **Features**
Real-time detection, haptic/audio feedback, session tracking, admin dashboard, user settings

## Diagram (Mermaid)

```mermaid
flowchart TB
  %% Client Tier
  subgraph "Client Tier"
    direction TB
    PWA["Client Browser (PWA)"]:::frontend
    subgraph "PWA Core"
      direction TB
      SWReg["Service Worker Registration"]:::frontend
      SW["Service Worker"]:::frontend
      Manifest["Web App Manifest"]:::frontend
    end
    subgraph "Pages" 
      direction TB
      HomePage["Home & Video Stream"]:::frontend
      NewSession["New Session Flow"]:::frontend
      SessionSummaryPage["Session Summary Page"]:::frontend
      AdminDashboard["Admin Dashboard Page"]:::frontend
      UserManagement["User Management Page"]:::frontend
      AllStats["All Stats Page"]:::frontend
    end
    subgraph "Components"
      direction TB
      DetectedList["DetectedObjectsList"]:::frontend
      VideoStream["VideoStream Component"]:::frontend
      Guidance["Detection Guidance Overlay"]:::frontend
      SessionAnalytics["Session Analytics"]:::frontend
      AdminStats["AdminDashboard Stats"]:::frontend
      DurationChart["SessionDurationChart"]:::frontend
    end
    subgraph "Context Providers"
      direction TB
      AuthCtx["AuthContext"]:::frontend
      SettingsCtx["SettingsContext"]:::frontend
      NotificationCtx["NotificationContext"]:::frontend
      ProtectedRoute["ProtectedRoute"]:::frontend
    end
    subgraph "Hooks"
      direction TB
      UseCamera["useCamera"]:::frontend
      UseModels["useModels"]:::frontend
      UseDepth["useDepthModel"]:::frontend
      UseObstacle["useUnidentifiedObstacleDetection"]:::frontend
    end
    subgraph "Utilities & ML"
      direction TB
      Speech["speech.js"]:::frontend
      Haptics["haptics.js"]:::frontend
      DepthWorker["depth.worker.js"]:::ml
      FastDepthModel["fastDepth Model"]:::ml
    end
  end

  %% API Tier
  subgraph "API Tier"
    direction TB
    Server["Express Server (server.js)"]:::backend
    subgraph "Routes"
      direction TB
      AuthRoute["Auth.route.js"]:::backend
      SessionsRoute["sessionsRoute.js"]:::backend
      UserRoute["user.route.js"]:::backend
    end
    subgraph "Controllers"
      direction TB
      AuthCtrl["authController.js"]:::backend
      SessionCtrl["sessionController.js"]:::backend
      UserCtrl["userController.js"]:::backend
    end
    Server --> AuthRoute & SessionsRoute & UserRoute
    AuthRoute --> AuthCtrl
    SessionsRoute --> SessionCtrl
    UserRoute --> UserCtrl
  end

  %% Data Tier
  subgraph "Data Tier"
    direction TB
    MongoDB["MongoDB"]:::database
  end

  %% External Services
  Vercel["Vercel Analytics"]:::external
  CDN["CDN (Static Assets)"]:::external

  %% Data Flows
  PWA --> SWReg
  SWReg --> SW
  SW --> PWA
  PWA --> Manifest
  HomePage --> VideoStream
  VideoStream --> UseCamera
  UseCamera --> VideoStream
  VideoStream --> UseModels
  VideoStream --> DepthWorker
  DepthWorker --> UseDepth
  UseModels --> DetectedList
  DetectedList --> Guidance
  UseObstacle --> Guidance
  Guidance --> SessionAnalytics
  Speech --> HomePage
  Haptics --> HomePage
  SessionSummaryPage --> SessionAnalytics
  AdminDashboard --> AdminStats & DurationChart
  AllStats --> DurationChart
  NewSession --> SessionSummaryPage
  SessionSummaryPage --> SessionsRoute
  AdminDashboard --> SessionsRoute
  UserManagement --> UserRoute
  AllStats --> SessionsRoute
  SessionsRoute --> SessionCtrl --> MongoDB
  AuthRoute --> AuthCtrl --> MongoDB
  UserRoute --> UserCtrl --> MongoDB
  Server --> MongoDB
  Server --> CDN
  Server -->|serves| FastDepthModel
  PWA -->|analytics| Vercel

  %% Click Events
  click PWA "https://github.com/dhanushsaicoder/project-iris/tree/main/frontend/src"
  click HomePage "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/pages/HomePage.jsx"
  click NewSession "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/pages/NewSession.jsx"
  click SessionSummaryPage "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/pages/SessionSummaryPage.jsx"
  click AdminDashboard "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/pages/AdminDashboardPage.jsx"
  click UserManagement "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/pages/UserManagementPage.jsx"
  click AllStats "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/pages/AllStatsPage.jsx"
  click DetectedList "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/components/ObjectDetector/DetectedObjectsList.jsx"
  click VideoStream "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/components/Home/VideoStream.jsx"
  click Guidance "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/components/DetectionGuidance.jsx"
  click SessionAnalytics "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/components/SessionSummary/SessionAnalytics.jsx"
  click AdminStats "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/components/AdminDashboard/Stats.jsx"
  click DurationChart "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/components/AdminDashboard/Charts/SessionDurationChart.jsx"
  click AuthCtx "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/context/AuthContext.jsx"
  click SettingsCtx "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/context/SettingsContext.jsx"
  click NotificationCtx "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/context/NotificationContext.jsx"
  click ProtectedRoute "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/context/ProtectedRoute.jsx"
  click UseCamera "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/hooks/useCamera.jsx"
  click UseModels "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/hooks/useModels.jsx"
  click UseDepth "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/hooks/useDepthModel.jsx"
  click UseObstacle "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/hooks/useUnidentifiedObstacleDetection.jsx"
  click DepthWorker "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/workers/depth.worker.js"
  click SWReg "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/serviceWorkerRegistration.js"
  click SW "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/service-worker.js"
  click Manifest "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/public/manifest.json"
  click Speech "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/utils/speech.js"
  click Haptics "https://github.com/dhanushsaicoder/project-iris/blob/main/frontend/src/utils/haptics.js"
  click Server "https://github.com/dhanushsaicoder/project-iris/blob/main/backend/server.js"
  click AuthRoute "https://github.com/dhanushsaicoder/project-iris/blob/main/backend/routes/Auth.route.js"
  click SessionsRoute "https://github.com/dhanushsaicoder/project-iris/blob/main/backend/routes/sessionsRoute.js"
  click UserRoute "https://github.com/dhanushsaicoder/project-iris/blob/main/backend/routes/user.route.js"
  click AuthCtrl "https://github.com/dhanushsaicoder/project-iris/blob/main/backend/Controllers/authController.js"
  click SessionCtrl "https://github.com/dhanushsaicoder/project-iris/blob/main/backend/Controllers/sessionController.js"
  click UserCtrl "https://github.com/dhanushsaicoder/project-iris/blob/main/backend/Controllers/userController.js"
  click MongoDB "https://github.com/dhanushsaicoder/project-iris/tree/main/backend/models"
  
  %% Styles
  classDef frontend fill:#D0E6FF,stroke:#0366d6,stroke-width:1px
  classDef backend fill:#DFFFE0,stroke:#28a745,stroke-width:1px
  classDef database fill:#FFE0B2,stroke:#e65100,stroke-width:1px
  classDef ml fill:#E1D5E7,stroke:#6f42c1,stroke-width:1px
  classDef external fill:#F0F0F0,stroke:#999,stroke-width:1px
```
