# vikelabs/vikeeats architecture

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

- Interactive diagram: https://gitdiagram.com/vikelabs/vikeeats
- Repository: https://github.com/vikelabs/vikeeats

## Overview

VikeEats is a campus food-outlet map with a Next.js frontend and Flask API. The main flow loads outlet data into the map, markers, filters, and outlet cards; users can also search menu items by name, outlet, or dietary restriction and view contact information. Backend capabilities include outlet-hours retrieval, menu parsing, dietary data, and SQLite-backed search. Some backend modules were only sampled or indexed, so the graph shows documented or excerpt-supported connections and leaves uncertain wiring out.

Main entry points: [`app/App.js`](https://github.com/vikelabs/vikeeats/blob/main/app/App.js) (Main app), [`api/db.py`](https://github.com/vikelabs/vikeeats/blob/main/api/db.py) (Database population), [`app/marker.js`](https://github.com/vikelabs/vikeeats/blob/main/app/marker.js) (Outlet markers), [`app/cards-manager.js`](https://github.com/vikelabs/vikeeats/blob/main/app/cards-manager.js) (Outlet cards)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Map interface"]
  node_app["Main app<br/>[App.js]"]
  node_mapview["Campus map<br/>[map.js]"]
  node_mapmanager["Map instance<br/>[map-manager.js]"]
  node_markers["Outlet markers<br/>[marker.js]"]
  node_category["Category state<br/>[category-state.js]"]
  node_filters["Category filters"]
  node_location["User location"]
  node_navbar["Navigation and search<br/>[Navbar.js]"]
  node_searchbar["Menu search UI<br/>[SearchBar.js]"]
  node_cards["Outlet cards<br/>[cards-manager.js]"]
  node_mincards["Outlet list<br/>[minimized-cards.js]"]
  node_maxcards["Outlet details<br/>[maximized-cards.js]"]
end

subgraph group_backend["Flask API"]
  node_uiapi["Outlet API<br/>[ui.py]"]
  node_searchapi["Menu search API<br/>[search_menu.py]"]
  node_outletapi["Outlet hours API<br/>[food_outlets.py]"]
  node_subapi["Sub hours and menus<br/>[sub.py]"]
  node_datetime["JSON date encoding<br/>[datetimeencoder.py]"]
end

subgraph group_ingest["Data collection"]
  node_menuparse["Menu parser<br/>[menu.py]"]
  node_outletparse["Outlet scraper<br/>[food_outlets.py]"]
  node_subparse["Sub scraper<br/>[sub.py]"]
end

subgraph group_storage["Menu data"]
  node_dbsync["Database population<br/>[db.py]"]
  node_schema["Database setup<br/>[create_db.py]"]
  node_sqlite[("Outlet and menu store<br/>[vikeeats.db]")]
end

subgraph group_contact["Contact"]
  node_contactpage["Contact page<br/>[contact-page.js]"]
end

node_visitor(("Campus visitor"))
node_uvic["UVic food listings"]
node_uvss["UVSS menu listings"]
node_menuweb["Outlet menu sites"]

node_visitor -->|"opens"| node_app
node_app -->|"fetches outlets"| node_uiapi
node_app -->|"renders"| node_mapview
node_app -->|"renders with data"| node_markers
node_app -->|"renders"| node_location
node_app -->|"renders"| node_filters
node_app -->|"renders with data"| node_navbar
node_app -->|"renders with data"| node_cards
node_mapview -->|"gets map"| node_mapmanager
node_markers -->|"gets map"| node_mapmanager
node_markers -->|"reads selection"| node_category
node_filters -->|"updates selection"| node_category
node_location -->|"gets map"| node_mapmanager
node_navbar -->|"renders"| node_searchbar
node_cards -->|"renders"| node_mincards
node_cards -->|"renders selected"| node_maxcards
node_searchbar -.->|"queries"| node_searchapi
node_uiapi -->|"uses data access"| node_dbsync
node_searchapi -->|"queries"| node_sqlite
node_dbsync -->|"populates"| node_sqlite
node_schema -->|"initializes"| node_sqlite
node_dbsync -->|"gets outlet data"| node_outletparse
node_dbsync -->|"uses menu data"| node_menuparse
node_dbsync -->|"uses menu data"| node_subparse
node_outletapi -->|"scrapes"| node_uvic
node_outletparse -->|"scrapes"| node_uvic
node_subparse -->|"scrapes"| node_uvss
node_menuparse -->|"fetches menus"| node_menuweb
node_visitor -->|"opens"| node_contactpage

click node_app "https://github.com/vikelabs/vikeeats/blob/main/app/App.js"
click node_mapview "https://github.com/vikelabs/vikeeats/blob/main/app/map.js"
click node_mapmanager "https://github.com/vikelabs/vikeeats/blob/main/app/map-manager.js"
click node_markers "https://github.com/vikelabs/vikeeats/blob/main/app/marker.js"
click node_category "https://github.com/vikelabs/vikeeats/blob/main/app/category-state.js"
click node_filters "https://github.com/vikelabs/vikeeats/blob/main/app/first-level-filter.js"
click node_location "https://github.com/vikelabs/vikeeats/blob/main/app/UserLocationMarker.js"
click node_navbar "https://github.com/vikelabs/vikeeats/blob/main/app/Navbar.js"
click node_searchbar "https://github.com/vikelabs/vikeeats/blob/main/app/SearchBar.js"
click node_cards "https://github.com/vikelabs/vikeeats/blob/main/app/cards-manager.js"
click node_mincards "https://github.com/vikelabs/vikeeats/blob/main/app/minimized-cards.js"
click node_maxcards "https://github.com/vikelabs/vikeeats/blob/main/app/maximized-cards.js"
click node_uiapi "https://github.com/vikelabs/vikeeats/blob/main/api/ui.py"
click node_searchapi "https://github.com/vikelabs/vikeeats/blob/main/api/search_menu.py"
click node_outletapi "https://github.com/vikelabs/vikeeats/blob/main/api/food_outlets.py"
click node_subapi "https://github.com/vikelabs/vikeeats/blob/main/api/sub.py"
click node_menuparse "https://github.com/vikelabs/vikeeats/blob/main/api/menu.py"
click node_outletparse "https://github.com/vikelabs/vikeeats/blob/main/api/food_outlets.py"
click node_subparse "https://github.com/vikelabs/vikeeats/blob/main/api/sub.py"
click node_dbsync "https://github.com/vikelabs/vikeeats/blob/main/api/db.py"
click node_schema "https://github.com/vikelabs/vikeeats/blob/main/api/create_db.py"
click node_sqlite "https://github.com/vikelabs/vikeeats/blob/main/api/vikeeats.db"
click node_datetime "https://github.com/vikelabs/vikeeats/blob/main/api/datetimeencoder.py"
click node_contactpage "https://github.com/vikelabs/vikeeats/blob/main/app/contact-page.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_mapview,node_mapmanager,node_markers,node_category,node_filters,node_location,node_navbar,node_searchbar,node_cards,node_mincards,node_maxcards toneBlue
class node_uiapi,node_searchapi,node_outletapi,node_subapi,node_datetime toneAmber
class node_menuparse,node_outletparse,node_subparse toneMint
class node_dbsync,node_schema,node_sqlite toneRose
class node_contactpage,node_visitor,node_uvic,node_uvss,node_menuweb toneIndigo
```

## Components

### Map interface

- [Main app](https://github.com/vikelabs/vikeeats/blob/main/app/App.js): `app/App.js`
- [Campus map](https://github.com/vikelabs/vikeeats/blob/main/app/map.js): `app/map.js`
- [Map instance](https://github.com/vikelabs/vikeeats/blob/main/app/map-manager.js): `app/map-manager.js`
- [Outlet markers](https://github.com/vikelabs/vikeeats/blob/main/app/marker.js): `app/marker.js`
- [Category state](https://github.com/vikelabs/vikeeats/blob/main/app/category-state.js): `app/category-state.js`
- [Category filters](https://github.com/vikelabs/vikeeats/blob/main/app/first-level-filter.js): `app/first-level-filter.js`
- [User location](https://github.com/vikelabs/vikeeats/blob/main/app/UserLocationMarker.js): `app/UserLocationMarker.js`
- [Navigation and search](https://github.com/vikelabs/vikeeats/blob/main/app/Navbar.js): `app/Navbar.js`
- [Menu search UI](https://github.com/vikelabs/vikeeats/blob/main/app/SearchBar.js): `app/SearchBar.js`
- [Outlet cards](https://github.com/vikelabs/vikeeats/blob/main/app/cards-manager.js): `app/cards-manager.js`
- [Outlet list](https://github.com/vikelabs/vikeeats/blob/main/app/minimized-cards.js): `app/minimized-cards.js`
- [Outlet details](https://github.com/vikelabs/vikeeats/blob/main/app/maximized-cards.js): `app/maximized-cards.js`

### Flask API

- [Outlet API](https://github.com/vikelabs/vikeeats/blob/main/api/ui.py): `api/ui.py`
- [Menu search API](https://github.com/vikelabs/vikeeats/blob/main/api/search_menu.py): `api/search_menu.py`
- [Outlet hours API](https://github.com/vikelabs/vikeeats/blob/main/api/food_outlets.py): `api/food_outlets.py`
- [Sub hours and menus](https://github.com/vikelabs/vikeeats/blob/main/api/sub.py): `api/sub.py`
- [JSON date encoding](https://github.com/vikelabs/vikeeats/blob/main/api/datetimeencoder.py): `api/datetimeencoder.py`

### Data collection

- [Menu parser](https://github.com/vikelabs/vikeeats/blob/main/api/menu.py): `api/menu.py`
- [Outlet scraper](https://github.com/vikelabs/vikeeats/blob/main/api/food_outlets.py): `api/food_outlets.py`
- [Sub scraper](https://github.com/vikelabs/vikeeats/blob/main/api/sub.py): `api/sub.py`

### Menu data

- [Database population](https://github.com/vikelabs/vikeeats/blob/main/api/db.py): `api/db.py`
- [Database setup](https://github.com/vikelabs/vikeeats/blob/main/api/create_db.py): `api/create_db.py`
- [Outlet and menu store](https://github.com/vikelabs/vikeeats/blob/main/api/vikeeats.db): `api/vikeeats.db`

### Contact

- [Contact page](https://github.com/vikelabs/vikeeats/blob/main/app/contact-page.js): `app/contact-page.js`

### Other components

- **Campus visitor**
- **UVic food listings**
- **UVSS menu listings**
- **Outlet menu sites**

## Connections

- Campus visitor → Main app: opens (evidence: `README.md`)
- Main app → Outlet API: fetches outlets (evidence: `app/App.js`)
- Main app → Campus map: renders (evidence: `app/App.js`)
- Main app → Outlet markers: renders with data (evidence: `app/App.js`)
- Main app → User location: renders (evidence: `app/App.js`)
- Main app → Category filters: renders (evidence: `app/App.js`)
- Main app → Navigation and search: renders with data (evidence: `app/App.js`)
- Main app → Outlet cards: renders with data (evidence: `app/App.js`)
- Campus map → Map instance: gets map (evidence: `app/map.js`)
- Outlet markers → Map instance: gets map (evidence: `app/marker.js`)
- Outlet markers → Category state: reads selection (evidence: `app/marker.js`)
- Category filters → Category state: updates selection (evidence: `app/first-level-filter.js`)
- User location → Map instance: gets map (evidence: `app/UserLocationMarker.js`)
- Navigation and search → Menu search UI: renders (evidence: `app/Navbar.js`)
- Outlet cards → Outlet list: renders (evidence: `app/cards-manager.js`)
- Outlet cards → Outlet details: renders selected (evidence: `app/cards-manager.js`)
- Menu search UI → Menu search API: queries
- Outlet API → Database population: uses data access (evidence: `api/ui.py`)
- Menu search API → Outlet and menu store: queries (evidence: `api/search_menu.py`)
- Database population → Outlet and menu store: populates (evidence: `api/db.py`)
- Database setup → Outlet and menu store: initializes (evidence: `README.md`)
- Database population → Outlet scraper: gets outlet data (evidence: `api/db.py`)
- Database population → Menu parser: uses menu data (evidence: `api/db.py`)
- Database population → Sub scraper: uses menu data (evidence: `api/db.py`)
- Outlet hours API → UVic food listings: scrapes (evidence: `api/food_outlets.py`)
- Outlet scraper → UVic food listings: scrapes (evidence: `api/food_outlets.py`)
- Sub scraper → UVSS menu listings: scrapes (evidence: `api/sub.py`)
- Menu parser → Outlet menu sites: fetches menus (evidence: `api/menu.py`)
- Campus visitor → Contact page: opens
