# amroabujabal/cosc310-snackoverflow architecture

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

- Interactive diagram: https://gitdiagram.com/amroabujabal/cosc310-snackoverflow
- Repository: https://github.com/amroabujabal/cosc310-snackoverflow

## Overview

SnackOverflow is a FastAPI food-delivery backend. Restaurant browsing and management flow through HTTP routes into domain services and JSON repositories; authenticated cart requests additionally validate customers and current menu availability before returning cart totals. The README also documents menu availability controls and restaurant/menu management UI. Cart, menu, restaurant, and customer data are JSON-backed. Relationships are included where shown by excerpts, the source index, or README; unsampled details are not inferred.

Main entry points: [`app/core/config.py`](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/core/config.py) (Data settings), [`app/main.py`](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/main.py) (FastAPI app), [`app/routes/menus.py`](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/routes/menus.py) (Menu routes), [`app/services/cart_service.py`](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/services/cart_service.py) (Cart service)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["API and interfaces"]
  node_app["FastAPI app<br/>[main.py]"]
  node_restaurant_api["Restaurant routes<br/>[restaurants.py]"]
  node_menu_api["Menu routes<br/>[menus.py]"]
  node_cart_api["Cart routes<br/>[cart.py]"]
  node_browse_ui["Browsing UI<br/>[app.js]"]
  node_management_ui["Management UI<br/>[management.js]"]
end

subgraph group_domain["Catalog and cart"]
  node_restaurant_service["Restaurant service"]
  node_menu_service["Menu service<br/>[menu_services.py]"]
  node_cart_service["Cart service<br/>[cart_service.py]"]
  node_domain_errors["Domain errors<br/>[exceptions.py]"]
  node_restaurant_contracts["Restaurant contracts"]
  node_menu_contracts["Menu item contracts"]
  node_menu_models["Menu models<br/>[menu.py]"]
  node_menu_item_model["Menu item model<br/>[menu_item.py]"]
  node_restaurant_model["Restaurant model<br/>[restaurant.py]"]
  node_cart_model["Cart models<br/>[cart.py]"]
end

subgraph group_identity["Customer identity"]
  node_auth["Authentication<br/>[auth.py]"]
  node_security["Token security<br/>[security.py]"]
  node_customer_model["Customer model<br/>[customer.py]"]
end

subgraph group_storage["JSON persistence"]
  node_customer_repo["Customer repository"]
  node_restaurant_repo["Restaurant repository"]
  node_menu_repo["Menu repository<br/>[menu_repository.py]"]
  node_cart_repo["Cart repository<br/>[cart_repository.py]"]
  node_settings["Data settings<br/>[config.py]"]
  node_customer_data[("Customers JSON<br/>[customers.json]")]
  node_restaurant_data[("Restaurants JSON<br/>[restaurants.json]")]
  node_menu_data[("Menus JSON<br/>[menus.json]")]
  node_cart_data[("Carts JSON<br/>[carts.json]")]
end

node_client(("API client"))

node_client -->|"sends requests"| node_app
node_app -->|"registers router"| node_restaurant_api
node_app -->|"registers router"| node_menu_api
node_app -->|"registers router"| node_cart_api
node_restaurant_api -->|"calls"| node_restaurant_service
node_menu_api -->|"calls"| node_menu_service
node_cart_api -->|"calls"| node_cart_service
node_cart_api -->|"authenticates with"| node_auth
node_restaurant_service -->|"reads and writes"| node_restaurant_repo
node_menu_service -->|"reads and writes"| node_menu_repo
node_menu_service -->|"checks restaurant"| node_restaurant_repo
node_cart_service -->|"transacts cart"| node_cart_repo
node_cart_service -->|"checks customer"| node_customer_repo
node_cart_service -->|"validates items"| node_menu_service
node_auth -->|"loads customer"| node_customer_repo
node_auth -->|"validates token"| node_security
node_restaurant_repo -->|"reads and writes"| node_restaurant_data
node_menu_repo -->|"reads and writes"| node_menu_data
node_cart_repo -->|"reads and writes"| node_cart_data
node_customer_repo -->|"reads and writes"| node_customer_data
node_restaurant_repo -->|"gets data path"| node_settings
node_menu_repo -->|"gets data path"| node_settings
node_cart_repo -->|"gets data path"| node_settings
node_customer_repo -->|"gets data path"| node_settings
node_security -->|"uses token settings"| node_settings
node_restaurant_api -.->|"serves management API"| node_management_ui
node_menu_api -.->|"serves management API"| node_management_ui
node_menu_api -.->|"serves browsing API"| node_browse_ui

click node_app "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/main.py"
click node_restaurant_api "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/routes/restaurants.py"
click node_menu_api "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/routes/menus.py"
click node_cart_api "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/routes/cart.py"
click node_browse_ui "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/frontend/app.js"
click node_management_ui "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/frontend/management.js"
click node_restaurant_service "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/services/restaurant_services.py"
click node_menu_service "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/services/menu_services.py"
click node_cart_service "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/services/cart_service.py"
click node_domain_errors "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/services/exceptions.py"
click node_restaurant_contracts "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/restaurant_requests.py"
click node_menu_contracts "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/menu_item_requests.py"
click node_menu_models "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/menu.py"
click node_menu_item_model "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/menu_item.py"
click node_restaurant_model "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/restaurant.py"
click node_cart_model "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/cart.py"
click node_auth "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/dependencies/auth.py"
click node_security "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/core/security.py"
click node_customer_model "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/customer.py"
click node_customer_repo "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/repositories/customer_repository.py"
click node_restaurant_repo "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/repositories/restaurant_repository.py"
click node_menu_repo "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/repositories/menu_repository.py"
click node_cart_repo "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/repositories/cart_repository.py"
click node_settings "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/core/config.py"
click node_customer_data "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/data/customers.json"
click node_restaurant_data "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/data/restaurants.json"
click node_menu_data "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/data/menus.json"
click node_cart_data "https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/data/carts.json"

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_restaurant_api,node_menu_api,node_cart_api,node_browse_ui,node_management_ui,node_client toneBlue
class node_restaurant_service,node_menu_service,node_cart_service,node_domain_errors,node_restaurant_contracts,node_menu_contracts,node_menu_models,node_menu_item_model,node_restaurant_model,node_cart_model toneAmber
class node_auth,node_security,node_customer_model toneMint
class node_customer_repo,node_restaurant_repo,node_menu_repo,node_cart_repo,node_settings,node_customer_data,node_restaurant_data,node_menu_data,node_cart_data toneRose
```

## Components

### API and interfaces

- [FastAPI app](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/main.py): `app/main.py`
- [Restaurant routes](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/routes/restaurants.py): `app/routes/restaurants.py`
- [Menu routes](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/routes/menus.py): `app/routes/menus.py`
- [Cart routes](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/routes/cart.py): `app/routes/cart.py`
- [Browsing UI](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/frontend/app.js): `app/frontend/app.js`
- [Management UI](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/frontend/management.js): `app/frontend/management.js`

### Catalog and cart

- [Restaurant service](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/services/restaurant_services.py): `app/services/restaurant_services.py`
- [Menu service](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/services/menu_services.py): `app/services/menu_services.py`
- [Cart service](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/services/cart_service.py): `app/services/cart_service.py`
- [Domain errors](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/services/exceptions.py): `app/services/exceptions.py`
- [Restaurant contracts](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/restaurant_requests.py): `app/models/restaurant_requests.py`
- [Menu item contracts](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/menu_item_requests.py): `app/models/menu_item_requests.py`
- [Menu models](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/menu.py): `app/models/menu.py`
- [Menu item model](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/menu_item.py): `app/models/menu_item.py`
- [Restaurant model](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/restaurant.py): `app/models/restaurant.py`
- [Cart models](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/cart.py): `app/models/cart.py`

### Customer identity

- [Authentication](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/dependencies/auth.py): `app/dependencies/auth.py`
- [Token security](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/core/security.py): `app/core/security.py`
- [Customer model](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/models/customer.py): `app/models/customer.py`

### JSON persistence

- [Customer repository](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/repositories/customer_repository.py): `app/repositories/customer_repository.py`
- [Restaurant repository](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/repositories/restaurant_repository.py): `app/repositories/restaurant_repository.py`
- [Menu repository](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/repositories/menu_repository.py): `app/repositories/menu_repository.py`
- [Cart repository](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/repositories/cart_repository.py): `app/repositories/cart_repository.py`
- [Data settings](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/app/core/config.py): `app/core/config.py`
- [Customers JSON](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/data/customers.json): `data/customers.json`
- [Restaurants JSON](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/data/restaurants.json): `data/restaurants.json`
- [Menus JSON](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/data/menus.json): `data/menus.json`
- [Carts JSON](https://github.com/amroabujabal/cosc310-snackoverflow/blob/main/data/carts.json): `data/carts.json`

### Other components

- **API client**

## Connections

- API client → FastAPI app: sends requests (evidence: `README.md`)
- FastAPI app → Restaurant routes: registers router (evidence: `app/main.py`)
- FastAPI app → Menu routes: registers router (evidence: `app/main.py`)
- FastAPI app → Cart routes: registers router (evidence: `app/main.py`)
- Restaurant routes → Restaurant service: calls (evidence: `app/routes/restaurants.py`)
- Menu routes → Menu service: calls (evidence: `app/routes/menus.py`)
- Cart routes → Cart service: calls (evidence: `app/routes/cart.py`)
- Cart routes → Authentication: authenticates with (evidence: `app/routes/cart.py`)
- Restaurant service → Restaurant repository: reads and writes (evidence: `app/services/restaurant_services.py`)
- Menu service → Menu repository: reads and writes (evidence: `app/services/menu_services.py`)
- Menu service → Restaurant repository: checks restaurant (evidence: `app/services/menu_services.py`)
- Cart service → Cart repository: transacts cart (evidence: `app/services/cart_service.py`)
- Cart service → Customer repository: checks customer (evidence: `app/services/cart_service.py`)
- Cart service → Menu service: validates items (evidence: `app/services/cart_service.py`)
- Authentication → Customer repository: loads customer (evidence: `app/dependencies/auth.py`)
- Authentication → Token security: validates token (evidence: `app/dependencies/auth.py`)
- Restaurant repository → Restaurants JSON: reads and writes (evidence: `app/repositories/restaurant_repository.py`)
- Menu repository → Menus JSON: reads and writes (evidence: `app/repositories/menu_repository.py`)
- Cart repository → Carts JSON: reads and writes (evidence: `app/repositories/cart_repository.py`)
- Customer repository → Customers JSON: reads and writes (evidence: `app/repositories/customer_repository.py`)
- Restaurant repository → Data settings: gets data path (evidence: `app/repositories/restaurant_repository.py`)
- Menu repository → Data settings: gets data path (evidence: `app/repositories/menu_repository.py`)
- Cart repository → Data settings: gets data path (evidence: `app/repositories/cart_repository.py`)
- Customer repository → Data settings: gets data path (evidence: `app/repositories/customer_repository.py`)
- Token security → Data settings: uses token settings (evidence: `app/core/security.py`)
- Restaurant routes → Management UI: serves management API (evidence: `README.md`)
- Menu routes → Management UI: serves management API (evidence: `README.md`)
- Menu routes → Browsing UI: serves browsing API (evidence: `README.md`)
