How ay2627s1-cs3219-p18/foc works
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: App.jsx UI router · auth.service.ts Account workflows · orders.service.ts Order workflow · CreateRequest.jsx Create request
Components 31
Student experience
- Demo state
foc-mockup/src/context/DemoContext.jsx - UI router
foc-mockup/src/App.jsx - Supplier browsing
foc-mockup/src/pages/Suppliers.jsx - Supplier details
foc-mockup/src/pages/SupplierDetail.jsx - Create request
foc-mockup/src/pages/CreateRequest.jsx - Request board
foc-mockup/src/pages/RequestBoard.jsx - Messaging
foc-mockup/src/pages/Chat.jsx - Activity history
foc-mockup/src/pages/Activity.jsx - Credit wallet
foc-mockup/src/pages/Wallet.jsx
Identity service
- Auth routes
user-service/src/routes/auth.routes.ts - Auth endpoints
user-service/src/controllers/auth.controller.ts - Account workflows
user-service/src/services/auth.service.ts - OTP workflows
user-service/src/services/otp.service.ts - User records
user-service/src/db/queries/users.queries.ts - OTP records
user-service/src/db/queries/otp.queries.ts - Session tokens
user-service/src/db/queries/tokens.queries.ts - Profile routes
user-service/src/routes/me.routes.ts - Profile workflows
user-service/src/services/me.service.ts - User routes
user-service/src/routes/users.routes.ts - User endpoints
user-service/src/controllers/users.controller.ts - User workflows
user-service/src/services/users.service.ts
Order service
- Order routes
order-service/src/routes/orders.routes.ts - Order endpoint
order-service/src/controllers/orders.controller.ts - Order workflow
order-service/src/services/orders.service.ts - Credits client
order-service/src/clients/credits.client.ts - Order database
order-service/src/db/prisma.ts
Credit service
- Credit routes
credit-service/src/routes/credits.routes.ts - Credit endpoints
credit-service/src/controllers/credits.controller.ts - Credit workflows
credit-service/src/services/credits.service.ts - Credit records
credit-service/src/db/queries/credits.queries.ts
Other components
- Student
Connections 30
- Student → UI router: uses
foc-mockup/src/App.jsx - UI router → Supplier browsing: routes to
foc-mockup/src/App.jsx - UI router → Supplier details: routes to
foc-mockup/src/App.jsx - UI router → Create request: routes to
foc-mockup/src/App.jsx - UI router → Request board: routes to
foc-mockup/src/App.jsx - UI router → Messaging: routes to
foc-mockup/src/App.jsx - UI router → Activity history: routes to
foc-mockup/src/App.jsx - UI router → Credit wallet: routes to
foc-mockup/src/App.jsx - Create request → Demo state: updates state
foc-mockup/src/pages/CreateRequest.jsx - Student → Auth routes: requests account access
user-service/src/routes/auth.routes.ts - Auth routes → Auth endpoints: dispatches
user-service/src/routes/auth.routes.ts - Auth endpoints → Account workflows: calls
user-service/src/controllers/auth.controller.ts - Account workflows → OTP workflows: uses
user-service/src/services/auth.service.ts - Account workflows → User records: reads and writes
user-service/src/services/auth.service.ts - Account workflows → OTP records: checks OTP
user-service/src/services/auth.service.ts - Account workflows → Session tokens: manages tokens
user-service/src/services/auth.service.ts - Student → Profile routes: requests profile
- Profile routes → Profile workflows: dispatches
user-service/src/routes/me.routes.ts - Student → User routes: requests user operations
- User routes → User endpoints: dispatches
user-service/src/routes/users.routes.ts - User endpoints → User workflows: calls
user-service/src/controllers/users.controller.ts - Student → Order routes: submits order
- Order routes → Order endpoint: dispatches
order-service/src/routes/orders.routes.ts - Order endpoint → Order workflow: calls
order-service/src/controllers/orders.controller.ts - Order workflow → Credits client: uses
order-service/src/services/orders.service.ts - Order workflow → Order database: persists orders
order-service/src/services/orders.service.ts - Student → Credit routes: requests credit operation
- Credit routes → Credit endpoints: dispatches
credit-service/src/routes/credits.routes.ts - Credit endpoints → Credit workflows: calls
credit-service/src/controllers/credits.controller.ts - Credit workflows → Credit records: reads and writes
credit-service/src/services/credits.service.ts