# shrivishal007/vendiconnect architecture

> Architecture diagram of the GitHub repository shrivishal007/vendiconnect, 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/shrivishal007/vendiconnect
- Repository: https://github.com/shrivishal007/vendiconnect

## Overview

VendiConnect is a backend platform connecting local street vendors with nearby residents. Its main workflow accepts vendor location updates, finds residents within their notification radii, throttles and records alerts, then sends push notifications; residents can also query nearby vendors. Separate API branches support resident accounts and preferences, vendor sessions and analytics, ratings, categories, and administrative operations. The graph reflects documented routes and sampled imports/calls; some capability links rely on README or route references, since several controllers and services were not excerpted.

Main entry points: [`Backend/src/app.js`](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/app.js) (API server), [`Backend/src/routes/vendorRoutes.js`](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/routes/vendorRoutes.js) (Vendor routes), [`Backend/src/services/proximityWorker.js`](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/services/proximityWorker.js) (Resident matching), [`Backend/src/routes/residentRoutes.js`](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/routes/residentRoutes.js) (Resident routes)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_api["API and access"]
  node_server["API server<br/>[app.js]"]
  node_resident_routes["Resident routes<br/>[residentRoutes.js]"]
  node_vendor_routes["Vendor routes<br/>[vendorRoutes.js]"]
  node_admin_routes["Admin routes<br/>[adminRoutes.js]"]
  node_auth["Authentication<br/>[auth.js]"]
end

subgraph group_discovery["Location discovery"]
  node_vendor_location["Location updates"]
  node_nearby["Nearby search"]
  node_location_data[("Vendor locations<br/>[Location.js]")]
  node_distance["Distance and status<br/>[haversine.js]"]
  node_matching["Resident matching<br/>[proximityWorker.js]"]
  node_alerts["Alert records<br/>[alertService.js]"]
  node_push["Push notifications<br/>[fcmService.js]"]
end

subgraph group_accounts["Community features"]
  node_resident_account["Resident accounts"]
  node_resident_data[("Resident profiles<br/>[Resident.js]")]
  node_preferences["Resident preferences"]
  node_vendor_sessions["Vendor consent sessions"]
  node_ratings["Vendor ratings"]
  node_categories["Categories"]
end

subgraph group_operations["Operations and reporting"]
  node_analytics["Vendor analytics"]
  node_admin_ops["Admin operations<br/>[adminController.js]"]
  node_vendor_admin["Vendor administration"]
  node_vendor_data[("Vendor records<br/>[Vendor.js]")]
  node_admin_data[("Admin accounts<br/>[AdminUser.js]")]
end

node_resident(("Residents"))
node_vendor(("Street vendors"))
node_admin(("Administrators"))
node_firebase["Firebase services"]

node_resident -->|"calls API"| node_server
node_vendor -->|"calls API"| node_server
node_admin -->|"calls API"| node_server
node_server -->|"mounts routes"| node_resident_routes
node_server -->|"mounts routes"| node_vendor_routes
node_server -->|"mounts routes"| node_admin_routes
node_resident_routes -->|"authenticates"| node_auth
node_resident_routes -->|"routes requests"| node_resident_account
node_resident_account -->|"reads and updates"| node_resident_data
node_resident_routes -->|"routes preferences"| node_preferences
node_vendor_routes -->|"routes updates"| node_vendor_location
node_vendor_routes -->|"routes searches"| node_nearby
node_vendor_location -->|"updates location"| node_location_data
node_nearby -->|"queries nearby"| node_location_data
node_nearby -->|"reads resident location"| node_resident_data
node_nearby -->|"calculates distance"| node_distance
node_vendor_location -.->|"triggers matching"| node_matching
node_matching -->|"reads residents"| node_resident_data
node_matching -->|"reads vendor"| node_vendor_data
node_matching -->|"calculates distance"| node_distance
node_matching -->|"checks and throttles"| node_alerts
node_matching -->|"sends notification"| node_push
node_push -->|"uses messaging"| node_firebase
node_vendor_routes -->|"routes consent"| node_vendor_sessions
node_vendor_routes -->|"routes reports"| node_analytics
node_admin_routes -->|"authenticates"| node_auth
node_admin_routes -->|"routes dashboard"| node_admin_ops
node_admin_ops -->|"reads admin"| node_admin_data
node_admin_ops -->|"counts vendors"| node_vendor_data
node_admin_ops -->|"counts residents"| node_resident_data
node_admin_routes -->|"routes management"| node_vendor_admin
node_vendor_admin -->|"manages vendors"| node_vendor_data
node_vendor_routes -.->|"routes ratings"| node_ratings
node_server -->|"mounts public routes"| node_categories

click node_server "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/app.js"
click node_resident_routes "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/routes/residentRoutes.js"
click node_vendor_routes "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/routes/vendorRoutes.js"
click node_admin_routes "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/routes/adminRoutes.js"
click node_auth "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/middleware/auth.js"
click node_resident_account "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/residentAuthController.js"
click node_resident_data "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/models/Resident.js"
click node_preferences "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/preferenceController.js"
click node_vendor_location "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/locationController.js"
click node_nearby "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/proximityController.js"
click node_location_data "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/models/Location.js"
click node_distance "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/utils/haversine.js"
click node_matching "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/services/proximityWorker.js"
click node_alerts "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/services/alertService.js"
click node_push "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/services/fcmService.js"
click node_vendor_sessions "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/vendorSessionController.js"
click node_ratings "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/ratingController.js"
click node_categories "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/categoryController.js"
click node_analytics "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/analyticsController.js"
click node_admin_ops "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/adminController.js"
click node_vendor_admin "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/adminVendorController.js"
click node_vendor_data "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/models/Vendor.js"
click node_admin_data "https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/models/AdminUser.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_server,node_resident_routes,node_vendor_routes,node_admin_routes,node_auth toneBlue
class node_vendor_location,node_nearby,node_location_data,node_distance,node_matching,node_alerts,node_push toneAmber
class node_resident_account,node_resident_data,node_preferences,node_vendor_sessions,node_ratings,node_categories toneMint
class node_analytics,node_admin_ops,node_vendor_admin,node_vendor_data,node_admin_data toneRose
class node_resident,node_vendor,node_admin,node_firebase toneIndigo
```

## Components

### API and access

- [API server](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/app.js): `Backend/src/app.js`
- [Resident routes](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/routes/residentRoutes.js): `Backend/src/routes/residentRoutes.js`
- [Vendor routes](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/routes/vendorRoutes.js): `Backend/src/routes/vendorRoutes.js`
- [Admin routes](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/routes/adminRoutes.js): `Backend/src/routes/adminRoutes.js`
- [Authentication](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/middleware/auth.js): `Backend/src/middleware/auth.js`

### Location discovery

- [Location updates](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/locationController.js): `Backend/src/controllers/locationController.js`
- [Nearby search](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/proximityController.js): `Backend/src/controllers/proximityController.js`
- [Vendor locations](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/models/Location.js): `Backend/src/models/Location.js`
- [Distance and status](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/utils/haversine.js): `Backend/src/utils/haversine.js`
- [Resident matching](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/services/proximityWorker.js): `Backend/src/services/proximityWorker.js`
- [Alert records](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/services/alertService.js): `Backend/src/services/alertService.js`
- [Push notifications](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/services/fcmService.js): `Backend/src/services/fcmService.js`

### Community features

- [Resident accounts](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/residentAuthController.js): `Backend/src/controllers/residentAuthController.js`
- [Resident profiles](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/models/Resident.js): `Backend/src/models/Resident.js`
- [Resident preferences](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/preferenceController.js): `Backend/src/controllers/preferenceController.js`
- [Vendor consent sessions](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/vendorSessionController.js): `Backend/src/controllers/vendorSessionController.js`
- [Vendor ratings](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/ratingController.js): `Backend/src/controllers/ratingController.js`
- [Categories](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/categoryController.js): `Backend/src/controllers/categoryController.js`

### Operations and reporting

- [Vendor analytics](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/analyticsController.js): `Backend/src/controllers/analyticsController.js`
- [Admin operations](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/adminController.js): `Backend/src/controllers/adminController.js`
- [Vendor administration](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/controllers/adminVendorController.js): `Backend/src/controllers/adminVendorController.js`
- [Vendor records](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/models/Vendor.js): `Backend/src/models/Vendor.js`
- [Admin accounts](https://github.com/shrivishal007/vendiconnect/blob/main/Backend/src/models/AdminUser.js): `Backend/src/models/AdminUser.js`

### Other components

- **Residents**
- **Street vendors**
- **Administrators**
- **Firebase services**

## Connections

- Residents → API server: calls API (evidence: `Backend/src/app.js`)
- Street vendors → API server: calls API (evidence: `Backend/src/app.js`)
- Administrators → API server: calls API (evidence: `Backend/src/app.js`)
- API server → Resident routes: mounts routes (evidence: `Backend/src/app.js`)
- API server → Vendor routes: mounts routes (evidence: `Backend/src/app.js`)
- API server → Admin routes: mounts routes (evidence: `Backend/src/app.js`)
- Resident routes → Authentication: authenticates (evidence: `Backend/src/routes/residentRoutes.js`)
- Resident routes → Resident accounts: routes requests (evidence: `Backend/src/routes/residentRoutes.js`)
- Resident accounts → Resident profiles: reads and updates (evidence: `Backend/src/controllers/residentAuthController.js`)
- Resident routes → Resident preferences: routes preferences (evidence: `Backend/src/routes/residentRoutes.js`)
- Vendor routes → Location updates: routes updates (evidence: `Backend/src/routes/vendorRoutes.js`)
- Vendor routes → Nearby search: routes searches (evidence: `Backend/src/routes/vendorRoutes.js`)
- Location updates → Vendor locations: updates location (evidence: `Backend/src/controllers/locationController.js`)
- Nearby search → Vendor locations: queries nearby (evidence: `Backend/src/controllers/proximityController.js`)
- Nearby search → Resident profiles: reads resident location (evidence: `Backend/src/controllers/proximityController.js`)
- Nearby search → Distance and status: calculates distance (evidence: `Backend/src/controllers/proximityController.js`)
- Location updates → Resident matching: triggers matching (evidence: `Backend/src/controllers/locationController.js`)
- Resident matching → Resident profiles: reads residents (evidence: `Backend/src/services/proximityWorker.js`)
- Resident matching → Vendor records: reads vendor (evidence: `Backend/src/services/proximityWorker.js`)
- Resident matching → Distance and status: calculates distance (evidence: `Backend/src/services/proximityWorker.js`)
- Resident matching → Alert records: checks and throttles (evidence: `Backend/src/services/proximityWorker.js`)
- Resident matching → Push notifications: sends notification (evidence: `Backend/src/services/proximityWorker.js`)
- Push notifications → Firebase services: uses messaging (evidence: `Backend/src/services/fcmService.js`)
- Vendor routes → Vendor consent sessions: routes consent (evidence: `Backend/src/routes/vendorRoutes.js`)
- Vendor routes → Vendor analytics: routes reports (evidence: `Backend/src/routes/vendorRoutes.js`)
- Admin routes → Authentication: authenticates (evidence: `Backend/src/routes/adminRoutes.js`)
- Admin routes → Admin operations: routes dashboard (evidence: `Backend/src/routes/adminRoutes.js`)
- Admin operations → Admin accounts: reads admin (evidence: `Backend/src/controllers/adminController.js`)
- Admin operations → Vendor records: counts vendors (evidence: `Backend/src/controllers/adminController.js`)
- Admin operations → Resident profiles: counts residents (evidence: `Backend/src/controllers/adminController.js`)
- Admin routes → Vendor administration: routes management (evidence: `Backend/src/routes/adminRoutes.js`)
- Vendor administration → Vendor records: manages vendors (evidence: `Backend/src/controllers/adminVendorController.js`)
- Vendor routes → Vendor ratings: routes ratings
- API server → Categories: mounts public routes (evidence: `Backend/src/app.js`)
