How dz1shetty/smart-nav works
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: App.jsx Route Application · FloorPlan.jsx Floor Map · searchEngine.js Search Engine · firebase.js Firebase Client
Components 27
Campus Navigation
- Route Application
src/App.jsx - Building Selector
src/components/home/HomePage.jsx - Search Interface
src/components/ui/SearchSystem.jsx - Search Engine
src/data/searchEngine.js - Search Worker Hook
src/hooks/useSearchWorker.js - Route Worker
src/workers/searchRouteWorker.js - Floor Map
src/components/map/FloorPlan.jsx - Map Renderer
src/components/map/FloorMapSVG.jsx - Navigation Assistant
src/components/ui/ChatbotWidget.jsx
Campus Content
- Search Index
src/data/searchIndex.js - Floor Registry
src/data/floorsData.js - Content Editors
src/components/modals/FacultyManagerModal.jsx
Custom Builder
- Custom Building Page
src/pages/CustomBuildingPage.jsx - Custom Floor Page
src/pages/CustomFloorPlanPage.jsx - Workspace Builder
src/pages/WorkspaceBuilderPage.tsx - Building Setup
src/components/builder/SetupModal.tsx - Builder Canvas Tools
src/components/builder/CanvasSurface.tsx - Builder State
src/store/useBuilderStore.ts - Building Importer
src/utils/buildingImporter.ts
Shared Services
- Image Upload
src/utils/cloudinaryUpload.js - Firebase Client
src/firebase.js - Theme State
src/context/ThemeContext.jsx - Theme Control
src/components/ui/ThemeToggle.jsx - Offline Cache
public/sw.js
Other components
- Visitor
- Cloudinary
- Firestore
Connections 35
- Visitor → Route Application: opens routes
src/App.jsx - Route Application → Building Selector: routes to
src/App.jsx - Route Application → Floor Map: routes to
src/App.jsx - Route Application → Custom Building Page: routes to
src/App.jsx - Route Application → Custom Floor Page: routes to
src/App.jsx - Route Application → Workspace Builder: routes to
src/App.jsx - Route Application → Navigation Assistant: renders
src/App.jsx - Building Selector → Search Interface: renders
src/components/home/HomePage.jsx - Visitor → Search Interface: enters query
- Search Interface → Search Worker Hook: resolves query
src/components/ui/SearchSystem.jsx - Search Worker Hook → Route Worker: posts query
src/hooks/useSearchWorker.js - Route Worker → Search Engine: resolves query
src/workers/searchRouteWorker.js - Search Worker Hook → Search Engine: fallback calls
src/hooks/useSearchWorker.js - Search Engine → Search Index: reads index
src/data/searchEngine.js - Search Interface → Search Engine: queries
src/components/ui/SearchSystem.jsx - Navigation Assistant → Search Engine: queries
src/components/ui/ChatbotWidget.jsx - Floor Map → Floor Registry: loads floors
src/components/map/FloorPlan.jsx - Floor Map → Search Index: reads metadata
src/components/map/FloorPlan.jsx - Floor Map → Map Renderer: renders map
src/components/map/FloorPlan.jsx - Floor Map → Firebase Client: reads dynamic layouts
src/components/map/FloorPlan.jsx - Firebase Client → Firestore: initializes client
src/firebase.js - Custom Building Page → Firebase Client: loads custom data
src/pages/CustomBuildingPage.jsx - Custom Floor Page → Firebase Client: loads custom data
src/pages/CustomFloorPlanPage.jsx - Workspace Builder → Building Setup: renders setup
src/pages/WorkspaceBuilderPage.tsx - Workspace Builder → Builder Canvas Tools: renders canvas
src/pages/WorkspaceBuilderPage.tsx - Workspace Builder → Builder State: uses state
src/pages/WorkspaceBuilderPage.tsx - Building Setup → Builder State: updates state
src/components/builder/SetupModal.tsx - Building Setup → Firebase Client: persists layouts
src/components/builder/SetupModal.tsx - Building Setup → Building Importer: imports buildings
src/components/builder/SetupModal.tsx - Building Importer → Floor Registry: reads floor data
src/utils/buildingImporter.ts - Content Editors → Image Upload: uploads images
src/components/modals/FacultyManagerModal.jsx - Building Selector → Image Upload: uploads images
src/components/home/HomePage.jsx - Image Upload → Cloudinary: sends images
- Theme Control → Theme State: toggles theme
src/components/ui/ThemeToggle.jsx - Visitor → Offline Cache: offline navigation
README.md