# ay2627s1-cs3219-p18/foc architecture

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

- Interactive diagram: https://gitdiagram.com/ay2627s1-cs3219-p18/foc
- Repository: https://github.com/ay2627s1-cs3219-p18/foc

## Overview

FoC is a campus errand platform with a student-facing demo, separate user, order, and credit services, and a closed-credit model. The intended user journey spans account access, browsing suppliers, creating or fulfilling requests, messaging, and wallet/activity views. The sampled order service handles order creation and uses a credits-client abstraction; the credit service exposes allocation and reservation operations. The mockup uses session-only demo state, not these services. Some feature paths are documented or present in the tree but were not sampled, so their internal connections are not asserted.

Main entry points: [`foc-mockup/src/App.jsx`](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/App.jsx) (UI router), [`user-service/src/services/auth.service.ts`](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/services/auth.service.ts) (Account workflows), [`order-service/src/services/orders.service.ts`](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/services/orders.service.ts) (Order workflow), [`foc-mockup/src/pages/CreateRequest.jsx`](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/CreateRequest.jsx) (Create request)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_frontend["Student experience"]
  node_demo["Demo state<br/>[DemoContext.jsx]"]
  node_app["UI router<br/>[App.jsx]"]
  node_supplier_browse["Supplier browsing<br/>[Suppliers.jsx]"]
  node_supplier_detail["Supplier details<br/>[SupplierDetail.jsx]"]
  node_request_create["Create request<br/>[CreateRequest.jsx]"]
  node_request_board["Request board<br/>[RequestBoard.jsx]"]
  node_chat["Messaging<br/>[Chat.jsx]"]
  node_activity["Activity history<br/>[Activity.jsx]"]
  node_wallet["Credit wallet<br/>[Wallet.jsx]"]
end

subgraph group_identity["Identity service"]
  node_auth_routes["Auth routes<br/>[auth.routes.ts]"]
  node_auth_controller["Auth endpoints<br/>[auth.controller.ts]"]
  node_auth_service["Account workflows<br/>[auth.service.ts]"]
  node_otp_service["OTP workflows<br/>[otp.service.ts]"]
  node_user_queries["User records<br/>[users.queries.ts]"]
  node_otp_queries["OTP records<br/>[otp.queries.ts]"]
  node_token_queries["Session tokens<br/>[tokens.queries.ts]"]
  node_me_routes["Profile routes<br/>[me.routes.ts]"]
  node_me_service["Profile workflows<br/>[me.service.ts]"]
  node_users_routes["User routes<br/>[users.routes.ts]"]
  node_users_controller["User endpoints"]
  node_users_service["User workflows<br/>[users.service.ts]"]
end

subgraph group_orders["Order service"]
  node_orders_routes["Order routes<br/>[orders.routes.ts]"]
  node_orders_controller["Order endpoint"]
  node_orders_service["Order workflow<br/>[orders.service.ts]"]
  node_credits_client["Credits client<br/>[credits.client.ts]"]
  node_order_store[("Order database<br/>[prisma.ts]")]
end

subgraph group_credits["Credit service"]
  node_credits_routes["Credit routes<br/>[credits.routes.ts]"]
  node_credits_controller["Credit endpoints"]
  node_credits_service["Credit workflows<br/>[credits.service.ts]"]
  node_credits_queries[("Credit records<br/>[credits.queries.ts]")]
end

node_student(("Student"))

node_student -->|"uses"| node_app
node_app -->|"routes to"| node_supplier_browse
node_app -->|"routes to"| node_supplier_detail
node_app -->|"routes to"| node_request_create
node_app -->|"routes to"| node_request_board
node_app -->|"routes to"| node_chat
node_app -->|"routes to"| node_activity
node_app -->|"routes to"| node_wallet
node_request_create -->|"updates state"| node_demo
node_student -->|"requests account access"| node_auth_routes
node_auth_routes -->|"dispatches"| node_auth_controller
node_auth_controller -->|"calls"| node_auth_service
node_auth_service -->|"uses"| node_otp_service
node_auth_service -->|"reads and writes"| node_user_queries
node_auth_service -->|"checks OTP"| node_otp_queries
node_auth_service -->|"manages tokens"| node_token_queries
node_student -->|"requests profile"| node_me_routes
node_me_routes -->|"dispatches"| node_me_service
node_student -->|"requests user operations"| node_users_routes
node_users_routes -->|"dispatches"| node_users_controller
node_users_controller -->|"calls"| node_users_service
node_student -->|"submits order"| node_orders_routes
node_orders_routes -->|"dispatches"| node_orders_controller
node_orders_controller -->|"calls"| node_orders_service
node_orders_service -->|"uses"| node_credits_client
node_orders_service -->|"persists orders"| node_order_store
node_student -->|"requests credit operation"| node_credits_routes
node_credits_routes -->|"dispatches"| node_credits_controller
node_credits_controller -->|"calls"| node_credits_service
node_credits_service -->|"reads and writes"| node_credits_queries

click node_demo "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/context/DemoContext.jsx"
click node_app "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/App.jsx"
click node_supplier_browse "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/Suppliers.jsx"
click node_supplier_detail "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/SupplierDetail.jsx"
click node_request_create "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/CreateRequest.jsx"
click node_request_board "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/RequestBoard.jsx"
click node_chat "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/Chat.jsx"
click node_activity "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/Activity.jsx"
click node_wallet "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/Wallet.jsx"
click node_auth_routes "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/routes/auth.routes.ts"
click node_auth_controller "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/controllers/auth.controller.ts"
click node_auth_service "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/services/auth.service.ts"
click node_otp_service "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/services/otp.service.ts"
click node_user_queries "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/db/queries/users.queries.ts"
click node_otp_queries "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/db/queries/otp.queries.ts"
click node_token_queries "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/db/queries/tokens.queries.ts"
click node_me_routes "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/routes/me.routes.ts"
click node_me_service "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/services/me.service.ts"
click node_users_routes "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/routes/users.routes.ts"
click node_users_controller "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/controllers/users.controller.ts"
click node_users_service "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/services/users.service.ts"
click node_orders_routes "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/routes/orders.routes.ts"
click node_orders_controller "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/controllers/orders.controller.ts"
click node_orders_service "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/services/orders.service.ts"
click node_credits_client "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/clients/credits.client.ts"
click node_order_store "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/db/prisma.ts"
click node_credits_routes "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/credit-service/src/routes/credits.routes.ts"
click node_credits_controller "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/credit-service/src/controllers/credits.controller.ts"
click node_credits_service "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/credit-service/src/services/credits.service.ts"
click node_credits_queries "https://github.com/ay2627s1-cs3219-p18/foc/blob/main/credit-service/src/db/queries/credits.queries.ts"

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_demo,node_app,node_supplier_browse,node_supplier_detail,node_request_create,node_request_board,node_chat,node_activity,node_wallet toneBlue
class node_auth_routes,node_auth_controller,node_auth_service,node_otp_service,node_user_queries,node_otp_queries,node_token_queries,node_me_routes,node_me_service,node_users_routes,node_users_controller,node_users_service toneAmber
class node_orders_routes,node_orders_controller,node_orders_service,node_credits_client,node_order_store toneMint
class node_credits_routes,node_credits_controller,node_credits_service,node_credits_queries toneRose
class node_student toneIndigo
```

## Components

### Student experience

- [Demo state](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/context/DemoContext.jsx): `foc-mockup/src/context/DemoContext.jsx`
- [UI router](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/App.jsx): `foc-mockup/src/App.jsx`
- [Supplier browsing](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/Suppliers.jsx): `foc-mockup/src/pages/Suppliers.jsx`
- [Supplier details](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/SupplierDetail.jsx): `foc-mockup/src/pages/SupplierDetail.jsx`
- [Create request](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/CreateRequest.jsx): `foc-mockup/src/pages/CreateRequest.jsx`
- [Request board](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/RequestBoard.jsx): `foc-mockup/src/pages/RequestBoard.jsx`
- [Messaging](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/Chat.jsx): `foc-mockup/src/pages/Chat.jsx`
- [Activity history](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/Activity.jsx): `foc-mockup/src/pages/Activity.jsx`
- [Credit wallet](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/foc-mockup/src/pages/Wallet.jsx): `foc-mockup/src/pages/Wallet.jsx`

### Identity service

- [Auth routes](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/routes/auth.routes.ts): `user-service/src/routes/auth.routes.ts`
- [Auth endpoints](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/controllers/auth.controller.ts): `user-service/src/controllers/auth.controller.ts`
- [Account workflows](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/services/auth.service.ts): `user-service/src/services/auth.service.ts`
- [OTP workflows](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/services/otp.service.ts): `user-service/src/services/otp.service.ts`
- [User records](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/db/queries/users.queries.ts): `user-service/src/db/queries/users.queries.ts`
- [OTP records](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/db/queries/otp.queries.ts): `user-service/src/db/queries/otp.queries.ts`
- [Session tokens](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/db/queries/tokens.queries.ts): `user-service/src/db/queries/tokens.queries.ts`
- [Profile routes](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/routes/me.routes.ts): `user-service/src/routes/me.routes.ts`
- [Profile workflows](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/services/me.service.ts): `user-service/src/services/me.service.ts`
- [User routes](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/routes/users.routes.ts): `user-service/src/routes/users.routes.ts`
- [User endpoints](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/controllers/users.controller.ts): `user-service/src/controllers/users.controller.ts`
- [User workflows](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/user-service/src/services/users.service.ts): `user-service/src/services/users.service.ts`

### Order service

- [Order routes](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/routes/orders.routes.ts): `order-service/src/routes/orders.routes.ts`
- [Order endpoint](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/controllers/orders.controller.ts): `order-service/src/controllers/orders.controller.ts`
- [Order workflow](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/services/orders.service.ts): `order-service/src/services/orders.service.ts`
- [Credits client](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/clients/credits.client.ts): `order-service/src/clients/credits.client.ts`
- [Order database](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/order-service/src/db/prisma.ts): `order-service/src/db/prisma.ts`

### Credit service

- [Credit routes](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/credit-service/src/routes/credits.routes.ts): `credit-service/src/routes/credits.routes.ts`
- [Credit endpoints](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/credit-service/src/controllers/credits.controller.ts): `credit-service/src/controllers/credits.controller.ts`
- [Credit workflows](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/credit-service/src/services/credits.service.ts): `credit-service/src/services/credits.service.ts`
- [Credit records](https://github.com/ay2627s1-cs3219-p18/foc/blob/main/credit-service/src/db/queries/credits.queries.ts): `credit-service/src/db/queries/credits.queries.ts`

### Other components

- **Student**

## Connections

- Student → UI router: uses (evidence: `foc-mockup/src/App.jsx`)
- UI router → Supplier browsing: routes to (evidence: `foc-mockup/src/App.jsx`)
- UI router → Supplier details: routes to (evidence: `foc-mockup/src/App.jsx`)
- UI router → Create request: routes to (evidence: `foc-mockup/src/App.jsx`)
- UI router → Request board: routes to (evidence: `foc-mockup/src/App.jsx`)
- UI router → Messaging: routes to (evidence: `foc-mockup/src/App.jsx`)
- UI router → Activity history: routes to (evidence: `foc-mockup/src/App.jsx`)
- UI router → Credit wallet: routes to (evidence: `foc-mockup/src/App.jsx`)
- Create request → Demo state: updates state (evidence: `foc-mockup/src/pages/CreateRequest.jsx`)
- Student → Auth routes: requests account access (evidence: `user-service/src/routes/auth.routes.ts`)
- Auth routes → Auth endpoints: dispatches (evidence: `user-service/src/routes/auth.routes.ts`)
- Auth endpoints → Account workflows: calls (evidence: `user-service/src/controllers/auth.controller.ts`)
- Account workflows → OTP workflows: uses (evidence: `user-service/src/services/auth.service.ts`)
- Account workflows → User records: reads and writes (evidence: `user-service/src/services/auth.service.ts`)
- Account workflows → OTP records: checks OTP (evidence: `user-service/src/services/auth.service.ts`)
- Account workflows → Session tokens: manages tokens (evidence: `user-service/src/services/auth.service.ts`)
- Student → Profile routes: requests profile
- Profile routes → Profile workflows: dispatches (evidence: `user-service/src/routes/me.routes.ts`)
- Student → User routes: requests user operations
- User routes → User endpoints: dispatches (evidence: `user-service/src/routes/users.routes.ts`)
- User endpoints → User workflows: calls (evidence: `user-service/src/controllers/users.controller.ts`)
- Student → Order routes: submits order
- Order routes → Order endpoint: dispatches (evidence: `order-service/src/routes/orders.routes.ts`)
- Order endpoint → Order workflow: calls (evidence: `order-service/src/controllers/orders.controller.ts`)
- Order workflow → Credits client: uses (evidence: `order-service/src/services/orders.service.ts`)
- Order workflow → Order database: persists orders (evidence: `order-service/src/services/orders.service.ts`)
- Student → Credit routes: requests credit operation
- Credit routes → Credit endpoints: dispatches (evidence: `credit-service/src/routes/credits.routes.ts`)
- Credit endpoints → Credit workflows: calls (evidence: `credit-service/src/controllers/credits.controller.ts`)
- Credit workflows → Credit records: reads and writes (evidence: `credit-service/src/services/credits.service.ts`)
