# shrivishalcr-wq/sop architecture

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

- Interactive diagram: https://gitdiagram.com/shrivishalcr-wq/sop
- Repository: https://github.com/shrivishalcr-wq/sop

## Overview

VendiConnect connects residents with nearby mobile vendors: vendors share locations, residents discover nearby vendors and receive proximity alerts, while residents and vendors can rate and manage their profiles. Vendors also onboard and manage consent through WhatsApp; administrators oversee operations through a web console. The graph follows the documented route and client wiring, but README evidence is absent and several controller, map, and notification implementations were not sampled, so uncertain runtime links are omitted.

Main entry points: [`Backend/src/routes/vendorRoutes.js`](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/routes/vendorRoutes.js) (Vendor endpoints), [`Backend/src/app.js`](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/app.js) (Express API), [`Backend/src/controllers/adminController.js`](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/adminController.js) (Admin operations), [`Backend/src/services/vendorSessionService.js`](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/services/vendorSessionService.js) (Consent sessions)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_resident["Resident app"]
  node_resident_app["Resident app<br/>[App.js]"]
  node_resident_auth["Resident authentication<br/>[AuthContext.js]"]
  node_resident_map["Vendor discovery map<br/>[MapScreen.js]"]
  node_resident_api["Resident API client<br/>[client.js]"]
end

subgraph group_vendor["Vendor services"]
  node_consent_sessions["Consent sessions"]
  node_whatsapp_client["WhatsApp webhook client<br/>[whatsapp-client.js]"]
  node_whatsapp_router["WhatsApp message router"]
  node_whatsapp_onboarding["WhatsApp onboarding"]
end

subgraph group_admin["Admin console"]
  node_admin_ui["Admin console<br/>[App.jsx]"]
  node_admin_routes["Admin navigation<br/>[router.jsx]"]
  node_admin_api["Admin API client<br/>[client.js]"]
end

subgraph group_backend["Backend API"]
  node_api_app["Express API<br/>[app.js]"]
  node_admin_routes_api["Admin endpoints<br/>[adminRoutes.js]"]
  node_vendor_routes_api["Vendor endpoints<br/>[vendorRoutes.js]"]
  node_resident_auth_controller["Resident account controller"]
  node_vendor_location["Location updates"]
  node_vendor_proximity["Nearby vendor search"]
  node_vendor_analytics["Vendor analytics"]
  node_vendor_activity["Vendor activity feed"]
  node_admin_controller["Admin operations<br/>[adminController.js]"]
  node_db_config["Database connection<br/>[db.js]"]
end

subgraph group_data["Domain data"]
  node_admin_store[("Admin accounts<br/>[AdminUser.js]")]
  node_resident_store[("Resident profiles<br/>[Resident.js]")]
  node_vendor_store[("Vendor profiles<br/>[Vendor.js]")]
  node_session_store[("Vendor sessions<br/>[VendorSession.js]")]
end

node_resident_user(("Resident"))
node_admin_user(("Administrator"))
node_firebase["Firebase Auth"]
node_whatsapp["WhatsApp"]

node_resident_user -->|"uses"| node_resident_app
node_resident_app -->|"provides auth"| node_resident_auth
node_resident_auth -->|"authenticates with"| node_firebase
node_resident_auth -->|"syncs profile through"| node_resident_api
node_resident_app -->|"navigates to"| node_resident_map
node_resident_map -.->|"requests vendor data"| node_resident_api
node_admin_user -->|"uses"| node_admin_ui
node_admin_ui -->|"loads routes"| node_admin_routes
node_admin_routes -.->|"pages request data"| node_admin_api
node_admin_api -.->|"calls API"| node_api_app
node_resident_api -.->|"calls API"| node_api_app
node_api_app -->|"connects database"| node_db_config
node_api_app -->|"mounts"| node_admin_routes_api
node_api_app -->|"mounts"| node_vendor_routes_api
node_api_app -->|"mounts resident routes"| node_resident_auth_controller
node_admin_routes_api -->|"routes requests to"| node_admin_controller
node_admin_routes_api -.->|"registers admin operations"| node_admin_store
node_admin_controller -->|"reads and writes"| node_admin_store
node_admin_controller -->|"reads dashboard counts"| node_vendor_store
node_admin_controller -->|"reads dashboard counts"| node_resident_store
node_vendor_routes_api -->|"routes location updates"| node_vendor_location
node_vendor_routes_api -->|"routes nearby search"| node_vendor_proximity
node_vendor_routes_api -->|"routes analytics"| node_vendor_analytics
node_vendor_routes_api -.->|"routes consent endpoints"| node_consent_sessions
node_vendor_routes_api -->|"routes activity feed"| node_vendor_activity
node_resident_auth_controller -->|"syncs and updates"| node_resident_store
node_whatsapp -.->|"sends messages"| node_whatsapp_client
node_whatsapp_client -->|"dispatches messages"| node_whatsapp_router
node_whatsapp_router -->|"delegates onboarding"| node_whatsapp_onboarding
node_whatsapp_router -->|"manages sessions"| node_consent_sessions
node_whatsapp_onboarding -->|"manages consent"| node_consent_sessions
node_consent_sessions -->|"reads and writes"| node_session_store

click node_resident_app "https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Resident/App.js"
click node_resident_auth "https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Resident/src/context/AuthContext.js"
click node_resident_map "https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Resident/src/screens/main/MapScreen.js"
click node_resident_api "https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Resident/src/api/client.js"
click node_admin_ui "https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Admin/src/App.jsx"
click node_admin_routes "https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Admin/src/routes/router.jsx"
click node_admin_api "https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Admin/src/api/client.js"
click node_api_app "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/app.js"
click node_admin_routes_api "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/routes/adminRoutes.js"
click node_vendor_routes_api "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/routes/vendorRoutes.js"
click node_resident_auth_controller "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/residentAuthController.js"
click node_vendor_location "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/locationController.js"
click node_vendor_proximity "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/proximityController.js"
click node_vendor_analytics "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/analyticsController.js"
click node_vendor_activity "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/activityLogController.js"
click node_consent_sessions "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/services/vendorSessionService.js"
click node_whatsapp_client "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/whatsapp-client.js"
click node_whatsapp_router "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/services/whatsappMessageRouter.js"
click node_whatsapp_onboarding "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/services/whatsappOnboardingService.js"
click node_admin_controller "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/adminController.js"
click node_db_config "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/config/db.js"
click node_admin_store "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/models/AdminUser.js"
click node_resident_store "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/models/Resident.js"
click node_vendor_store "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/models/Vendor.js"
click node_session_store "https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/models/VendorSession.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_resident_app,node_resident_auth,node_resident_map,node_resident_api toneBlue
class node_consent_sessions,node_whatsapp_client,node_whatsapp_router,node_whatsapp_onboarding toneAmber
class node_admin_ui,node_admin_routes,node_admin_api toneMint
class node_api_app,node_admin_routes_api,node_vendor_routes_api,node_resident_auth_controller,node_vendor_location,node_vendor_proximity,node_vendor_analytics,node_vendor_activity,node_admin_controller,node_db_config toneRose
class node_admin_store,node_resident_store,node_vendor_store,node_session_store,node_resident_user,node_admin_user,node_firebase,node_whatsapp toneIndigo
```

## Components

### Resident app

- [Resident app](https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Resident/App.js): `Frontend/Resident/App.js`
- [Resident authentication](https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Resident/src/context/AuthContext.js): `Frontend/Resident/src/context/AuthContext.js`
- [Vendor discovery map](https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Resident/src/screens/main/MapScreen.js): `Frontend/Resident/src/screens/main/MapScreen.js`
- [Resident API client](https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Resident/src/api/client.js): `Frontend/Resident/src/api/client.js`

### Vendor services

- [Consent sessions](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/services/vendorSessionService.js): `Backend/src/services/vendorSessionService.js`
- [WhatsApp webhook client](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/whatsapp-client.js): `Backend/src/whatsapp-client.js`
- [WhatsApp message router](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/services/whatsappMessageRouter.js): `Backend/src/services/whatsappMessageRouter.js`
- [WhatsApp onboarding](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/services/whatsappOnboardingService.js): `Backend/src/services/whatsappOnboardingService.js`

### Admin console

- [Admin console](https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Admin/src/App.jsx): `Frontend/Admin/src/App.jsx`
- [Admin navigation](https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Admin/src/routes/router.jsx): `Frontend/Admin/src/routes/router.jsx`
- [Admin API client](https://github.com/shrivishalcr-wq/sop/blob/main/Frontend/Admin/src/api/client.js): `Frontend/Admin/src/api/client.js`

### Backend API

- [Express API](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/app.js): `Backend/src/app.js`
- [Admin endpoints](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/routes/adminRoutes.js): `Backend/src/routes/adminRoutes.js`
- [Vendor endpoints](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/routes/vendorRoutes.js): `Backend/src/routes/vendorRoutes.js`
- [Resident account controller](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/residentAuthController.js): `Backend/src/controllers/residentAuthController.js`
- [Location updates](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/locationController.js): `Backend/src/controllers/locationController.js`
- [Nearby vendor search](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/proximityController.js): `Backend/src/controllers/proximityController.js`
- [Vendor analytics](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/analyticsController.js): `Backend/src/controllers/analyticsController.js`
- [Vendor activity feed](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/activityLogController.js): `Backend/src/controllers/activityLogController.js`
- [Admin operations](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/controllers/adminController.js): `Backend/src/controllers/adminController.js`
- [Database connection](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/config/db.js): `Backend/src/config/db.js`

### Domain data

- [Admin accounts](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/models/AdminUser.js): `Backend/src/models/AdminUser.js`
- [Resident profiles](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/models/Resident.js): `Backend/src/models/Resident.js`
- [Vendor profiles](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/models/Vendor.js): `Backend/src/models/Vendor.js`
- [Vendor sessions](https://github.com/shrivishalcr-wq/sop/blob/main/Backend/src/models/VendorSession.js): `Backend/src/models/VendorSession.js`

### Other components

- **Resident**
- **Administrator**
- **Firebase Auth**
- **WhatsApp**

## Connections

- Resident → Resident app: uses
- Resident app → Resident authentication: provides auth (evidence: `Frontend/Resident/App.js`)
- Resident authentication → Firebase Auth: authenticates with (evidence: `Frontend/Resident/src/context/AuthContext.js`)
- Resident authentication → Resident API client: syncs profile through (evidence: `Frontend/Resident/src/context/AuthContext.js`)
- Resident app → Vendor discovery map: navigates to
- Vendor discovery map → Resident API client: requests vendor data
- Administrator → Admin console: uses
- Admin console → Admin navigation: loads routes (evidence: `Frontend/Admin/src/App.jsx`)
- Admin navigation → Admin API client: pages request data
- Admin API client → Express API: calls API
- Resident API client → Express API: calls API
- Express API → Database connection: connects database (evidence: `Backend/src/app.js`)
- Express API → Admin endpoints: mounts (evidence: `Backend/src/app.js`)
- Express API → Vendor endpoints: mounts (evidence: `Backend/src/app.js`)
- Express API → Resident account controller: mounts resident routes (evidence: `Backend/src/app.js`)
- Admin endpoints → Admin operations: routes requests to (evidence: `Backend/src/routes/adminRoutes.js`)
- Admin endpoints → Admin accounts: registers admin operations
- Admin operations → Admin accounts: reads and writes (evidence: `Backend/src/controllers/adminController.js`)
- Admin operations → Vendor profiles: reads dashboard counts (evidence: `Backend/src/controllers/adminController.js`)
- Admin operations → Resident profiles: reads dashboard counts (evidence: `Backend/src/controllers/adminController.js`)
- Vendor endpoints → Location updates: routes location updates (evidence: `Backend/src/routes/vendorRoutes.js`)
- Vendor endpoints → Nearby vendor search: routes nearby search (evidence: `Backend/src/routes/vendorRoutes.js`)
- Vendor endpoints → Vendor analytics: routes analytics (evidence: `Backend/src/routes/vendorRoutes.js`)
- Vendor endpoints → Consent sessions: routes consent endpoints
- Vendor endpoints → Vendor activity feed: routes activity feed (evidence: `Backend/src/routes/vendorRoutes.js`)
- Resident account controller → Resident profiles: syncs and updates (evidence: `Backend/src/controllers/residentAuthController.js`)
- WhatsApp → WhatsApp webhook client: sends messages
- WhatsApp webhook client → WhatsApp message router: dispatches messages (evidence: `Backend/src/whatsapp-client.js`)
- WhatsApp message router → WhatsApp onboarding: delegates onboarding (evidence: `Backend/src/services/whatsappMessageRouter.js`)
- WhatsApp message router → Consent sessions: manages sessions (evidence: `Backend/src/services/whatsappMessageRouter.js`)
- WhatsApp onboarding → Consent sessions: manages consent (evidence: `Backend/src/services/whatsappOnboardingService.js`)
- Consent sessions → Vendor sessions: reads and writes (evidence: `Backend/src/services/vendorSessionService.js`)
