# dz1shetty/smart-nav architecture

> Architecture diagram of the GitHub repository dz1shetty/smart-nav, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-18). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dz1shetty/smart-nav
- Repository: https://github.com/dz1shetty/smart-nav

## Overview

SmartNav is a campus indoor-navigation application: visitors select a building or search for a room or faculty member, then open a floor map and follow directions. Its main product branches are the searchable campus map, a separate custom-building workspace, and administrative editing of campus content and images. Static floor records and a generated search index support discovery; Firebase provides client-side persistence, and Cloudinary handles image uploads. The README also documents offline PWA navigation. Some listed UI modules were not sampled, so uncertain connections are omitted.

Main entry points: [`src/App.jsx`](https://github.com/dz1shetty/smart-nav/blob/main/src/App.jsx) (Route Application), [`src/components/map/FloorPlan.jsx`](https://github.com/dz1shetty/smart-nav/blob/main/src/components/map/FloorPlan.jsx) (Floor Map), [`src/data/searchEngine.js`](https://github.com/dz1shetty/smart-nav/blob/main/src/data/searchEngine.js) (Search Engine), [`src/firebase.js`](https://github.com/dz1shetty/smart-nav/blob/main/src/firebase.js) (Firebase Client)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_navigation["Campus Navigation"]
  node_app["Route Application<br/>[App.jsx]"]
  node_home["Building Selector<br/>[HomePage.jsx]"]
  node_searchui["Search Interface<br/>[SearchSystem.jsx]"]
  node_searchengine["Search Engine<br/>[searchEngine.js]"]
  node_workerhook["Search Worker Hook<br/>[useSearchWorker.js]"]
  node_worker["Route Worker"]
  node_floorpage["Floor Map<br/>[FloorPlan.jsx]"]
  node_maprenderer["Map Renderer<br/>[FloorMapSVG.jsx]"]
  node_chatbot["Navigation Assistant<br/>[ChatbotWidget.jsx]"]
end

subgraph group_content["Campus Content"]
  node_searchindex["Search Index<br/>[searchIndex.js]"]
  node_floors["Floor Registry<br/>[floorsData.js]"]
  node_admin["Content Editors"]
end

subgraph group_builder["Custom Builder"]
  node_custompage["Custom Building Page"]
  node_customfloor["Custom Floor Page"]
  node_workspace["Workspace Builder"]
  node_setup["Building Setup<br/>[SetupModal.tsx]"]
  node_buildertools["Builder Canvas Tools<br/>[CanvasSurface.tsx]"]
  node_builderstore["Builder State<br/>[useBuilderStore.ts]"]
  node_importer["Building Importer"]
end

subgraph group_platform["Shared Services"]
  node_upload["Image Upload"]
  node_firebase["Firebase Client<br/>[firebase.js]"]
  node_theme["Theme State<br/>[ThemeContext.jsx]"]
  node_themecontrol["Theme Control<br/>[ThemeToggle.jsx]"]
  node_serviceworker["Offline Cache<br/>[sw.js]"]
end

node_visitor(("Visitor"))
node_cloudinary(("Cloudinary"))
node_firestore[("Firestore")]

node_visitor -->|"opens routes"| node_app
node_app -->|"routes to"| node_home
node_app -->|"routes to"| node_floorpage
node_app -->|"routes to"| node_custompage
node_app -->|"routes to"| node_customfloor
node_app -->|"routes to"| node_workspace
node_app -->|"renders"| node_chatbot
node_home -->|"renders"| node_searchui
node_visitor -.->|"enters query"| node_searchui
node_searchui -->|"resolves query"| node_workerhook
node_workerhook -->|"posts query"| node_worker
node_worker -->|"resolves query"| node_searchengine
node_workerhook -->|"fallback calls"| node_searchengine
node_searchengine -->|"reads index"| node_searchindex
node_searchui -->|"queries"| node_searchengine
node_chatbot -->|"queries"| node_searchengine
node_floorpage -->|"loads floors"| node_floors
node_floorpage -->|"reads metadata"| node_searchindex
node_floorpage -->|"renders map"| node_maprenderer
node_floorpage -->|"reads dynamic layouts"| node_firebase
node_firebase -->|"initializes client"| node_firestore
node_custompage -->|"loads custom data"| node_firebase
node_customfloor -->|"loads custom data"| node_firebase
node_workspace -->|"renders setup"| node_setup
node_workspace -->|"renders canvas"| node_buildertools
node_workspace -->|"uses state"| node_builderstore
node_setup -->|"updates state"| node_builderstore
node_setup -->|"persists layouts"| node_firebase
node_setup -->|"imports buildings"| node_importer
node_importer -->|"reads floor data"| node_floors
node_admin -->|"uploads images"| node_upload
node_home -->|"uploads images"| node_upload
node_upload -.->|"sends images"| node_cloudinary
node_themecontrol -->|"toggles theme"| node_theme
node_visitor -.->|"offline navigation"| node_serviceworker

click node_app "https://github.com/dz1shetty/smart-nav/blob/main/src/App.jsx"
click node_home "https://github.com/dz1shetty/smart-nav/blob/main/src/components/home/HomePage.jsx"
click node_searchui "https://github.com/dz1shetty/smart-nav/blob/main/src/components/ui/SearchSystem.jsx"
click node_searchengine "https://github.com/dz1shetty/smart-nav/blob/main/src/data/searchEngine.js"
click node_searchindex "https://github.com/dz1shetty/smart-nav/blob/main/src/data/searchIndex.js"
click node_workerhook "https://github.com/dz1shetty/smart-nav/blob/main/src/hooks/useSearchWorker.js"
click node_worker "https://github.com/dz1shetty/smart-nav/blob/main/src/workers/searchRouteWorker.js"
click node_floorpage "https://github.com/dz1shetty/smart-nav/blob/main/src/components/map/FloorPlan.jsx"
click node_maprenderer "https://github.com/dz1shetty/smart-nav/blob/main/src/components/map/FloorMapSVG.jsx"
click node_floors "https://github.com/dz1shetty/smart-nav/blob/main/src/data/floorsData.js"
click node_chatbot "https://github.com/dz1shetty/smart-nav/blob/main/src/components/ui/ChatbotWidget.jsx"
click node_admin "https://github.com/dz1shetty/smart-nav/blob/main/src/components/modals/FacultyManagerModal.jsx"
click node_upload "https://github.com/dz1shetty/smart-nav/blob/main/src/utils/cloudinaryUpload.js"
click node_custompage "https://github.com/dz1shetty/smart-nav/blob/main/src/pages/CustomBuildingPage.jsx"
click node_customfloor "https://github.com/dz1shetty/smart-nav/blob/main/src/pages/CustomFloorPlanPage.jsx"
click node_workspace "https://github.com/dz1shetty/smart-nav/blob/main/src/pages/WorkspaceBuilderPage.tsx"
click node_setup "https://github.com/dz1shetty/smart-nav/blob/main/src/components/builder/SetupModal.tsx"
click node_buildertools "https://github.com/dz1shetty/smart-nav/blob/main/src/components/builder/CanvasSurface.tsx"
click node_builderstore "https://github.com/dz1shetty/smart-nav/blob/main/src/store/useBuilderStore.ts"
click node_importer "https://github.com/dz1shetty/smart-nav/blob/main/src/utils/buildingImporter.ts"
click node_firebase "https://github.com/dz1shetty/smart-nav/blob/main/src/firebase.js"
click node_theme "https://github.com/dz1shetty/smart-nav/blob/main/src/context/ThemeContext.jsx"
click node_themecontrol "https://github.com/dz1shetty/smart-nav/blob/main/src/components/ui/ThemeToggle.jsx"
click node_serviceworker "https://github.com/dz1shetty/smart-nav/blob/main/public/sw.js"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_app,node_home,node_searchui,node_searchengine,node_workerhook,node_worker,node_floorpage,node_maprenderer,node_chatbot toneBlue
class node_searchindex,node_floors,node_admin,node_firestore toneAmber
class node_custompage,node_customfloor,node_workspace,node_setup,node_buildertools,node_builderstore,node_importer toneMint
class node_upload,node_firebase,node_theme,node_themecontrol,node_serviceworker toneRose
class node_visitor,node_cloudinary toneIndigo
```

## Components

### Campus Navigation

- [Route Application](https://github.com/dz1shetty/smart-nav/blob/main/src/App.jsx): `src/App.jsx`
- [Building Selector](https://github.com/dz1shetty/smart-nav/blob/main/src/components/home/HomePage.jsx): `src/components/home/HomePage.jsx`
- [Search Interface](https://github.com/dz1shetty/smart-nav/blob/main/src/components/ui/SearchSystem.jsx): `src/components/ui/SearchSystem.jsx`
- [Search Engine](https://github.com/dz1shetty/smart-nav/blob/main/src/data/searchEngine.js): `src/data/searchEngine.js`
- [Search Worker Hook](https://github.com/dz1shetty/smart-nav/blob/main/src/hooks/useSearchWorker.js): `src/hooks/useSearchWorker.js`
- [Route Worker](https://github.com/dz1shetty/smart-nav/blob/main/src/workers/searchRouteWorker.js): `src/workers/searchRouteWorker.js`
- [Floor Map](https://github.com/dz1shetty/smart-nav/blob/main/src/components/map/FloorPlan.jsx): `src/components/map/FloorPlan.jsx`
- [Map Renderer](https://github.com/dz1shetty/smart-nav/blob/main/src/components/map/FloorMapSVG.jsx): `src/components/map/FloorMapSVG.jsx`
- [Navigation Assistant](https://github.com/dz1shetty/smart-nav/blob/main/src/components/ui/ChatbotWidget.jsx): `src/components/ui/ChatbotWidget.jsx`

### Campus Content

- [Search Index](https://github.com/dz1shetty/smart-nav/blob/main/src/data/searchIndex.js): `src/data/searchIndex.js`
- [Floor Registry](https://github.com/dz1shetty/smart-nav/blob/main/src/data/floorsData.js): `src/data/floorsData.js`
- [Content Editors](https://github.com/dz1shetty/smart-nav/blob/main/src/components/modals/FacultyManagerModal.jsx): `src/components/modals/FacultyManagerModal.jsx`

### Custom Builder

- [Custom Building Page](https://github.com/dz1shetty/smart-nav/blob/main/src/pages/CustomBuildingPage.jsx): `src/pages/CustomBuildingPage.jsx`
- [Custom Floor Page](https://github.com/dz1shetty/smart-nav/blob/main/src/pages/CustomFloorPlanPage.jsx): `src/pages/CustomFloorPlanPage.jsx`
- [Workspace Builder](https://github.com/dz1shetty/smart-nav/blob/main/src/pages/WorkspaceBuilderPage.tsx): `src/pages/WorkspaceBuilderPage.tsx`
- [Building Setup](https://github.com/dz1shetty/smart-nav/blob/main/src/components/builder/SetupModal.tsx): `src/components/builder/SetupModal.tsx`
- [Builder Canvas Tools](https://github.com/dz1shetty/smart-nav/blob/main/src/components/builder/CanvasSurface.tsx): `src/components/builder/CanvasSurface.tsx`
- [Builder State](https://github.com/dz1shetty/smart-nav/blob/main/src/store/useBuilderStore.ts): `src/store/useBuilderStore.ts`
- [Building Importer](https://github.com/dz1shetty/smart-nav/blob/main/src/utils/buildingImporter.ts): `src/utils/buildingImporter.ts`

### Shared Services

- [Image Upload](https://github.com/dz1shetty/smart-nav/blob/main/src/utils/cloudinaryUpload.js): `src/utils/cloudinaryUpload.js`
- [Firebase Client](https://github.com/dz1shetty/smart-nav/blob/main/src/firebase.js): `src/firebase.js`
- [Theme State](https://github.com/dz1shetty/smart-nav/blob/main/src/context/ThemeContext.jsx): `src/context/ThemeContext.jsx`
- [Theme Control](https://github.com/dz1shetty/smart-nav/blob/main/src/components/ui/ThemeToggle.jsx): `src/components/ui/ThemeToggle.jsx`
- [Offline Cache](https://github.com/dz1shetty/smart-nav/blob/main/public/sw.js): `public/sw.js`

### Other components

- **Visitor**
- **Cloudinary**
- **Firestore**

## Connections

- Visitor → Route Application: opens routes (evidence: `src/App.jsx`)
- Route Application → Building Selector: routes to (evidence: `src/App.jsx`)
- Route Application → Floor Map: routes to (evidence: `src/App.jsx`)
- Route Application → Custom Building Page: routes to (evidence: `src/App.jsx`)
- Route Application → Custom Floor Page: routes to (evidence: `src/App.jsx`)
- Route Application → Workspace Builder: routes to (evidence: `src/App.jsx`)
- Route Application → Navigation Assistant: renders (evidence: `src/App.jsx`)
- Building Selector → Search Interface: renders (evidence: `src/components/home/HomePage.jsx`)
- Visitor → Search Interface: enters query
- Search Interface → Search Worker Hook: resolves query (evidence: `src/components/ui/SearchSystem.jsx`)
- Search Worker Hook → Route Worker: posts query (evidence: `src/hooks/useSearchWorker.js`)
- Route Worker → Search Engine: resolves query (evidence: `src/workers/searchRouteWorker.js`)
- Search Worker Hook → Search Engine: fallback calls (evidence: `src/hooks/useSearchWorker.js`)
- Search Engine → Search Index: reads index (evidence: `src/data/searchEngine.js`)
- Search Interface → Search Engine: queries (evidence: `src/components/ui/SearchSystem.jsx`)
- Navigation Assistant → Search Engine: queries (evidence: `src/components/ui/ChatbotWidget.jsx`)
- Floor Map → Floor Registry: loads floors (evidence: `src/components/map/FloorPlan.jsx`)
- Floor Map → Search Index: reads metadata (evidence: `src/components/map/FloorPlan.jsx`)
- Floor Map → Map Renderer: renders map (evidence: `src/components/map/FloorPlan.jsx`)
- Floor Map → Firebase Client: reads dynamic layouts (evidence: `src/components/map/FloorPlan.jsx`)
- Firebase Client → Firestore: initializes client (evidence: `src/firebase.js`)
- Custom Building Page → Firebase Client: loads custom data (evidence: `src/pages/CustomBuildingPage.jsx`)
- Custom Floor Page → Firebase Client: loads custom data (evidence: `src/pages/CustomFloorPlanPage.jsx`)
- Workspace Builder → Building Setup: renders setup (evidence: `src/pages/WorkspaceBuilderPage.tsx`)
- Workspace Builder → Builder Canvas Tools: renders canvas (evidence: `src/pages/WorkspaceBuilderPage.tsx`)
- Workspace Builder → Builder State: uses state (evidence: `src/pages/WorkspaceBuilderPage.tsx`)
- Building Setup → Builder State: updates state (evidence: `src/components/builder/SetupModal.tsx`)
- Building Setup → Firebase Client: persists layouts (evidence: `src/components/builder/SetupModal.tsx`)
- Building Setup → Building Importer: imports buildings (evidence: `src/components/builder/SetupModal.tsx`)
- Building Importer → Floor Registry: reads floor data (evidence: `src/utils/buildingImporter.ts`)
- Content Editors → Image Upload: uploads images (evidence: `src/components/modals/FacultyManagerModal.jsx`)
- Building Selector → Image Upload: uploads images (evidence: `src/components/home/HomePage.jsx`)
- Image Upload → Cloudinary: sends images
- Theme Control → Theme State: toggles theme (evidence: `src/components/ui/ThemeToggle.jsx`)
- Visitor → Offline Cache: offline navigation (evidence: `README.md`)
