How aljayvee/capstone_server works
SUGO On-The-Go is a logistics and on-demand errand backend. Its central workflow accepts customer errands, supports dispatcher and rider lifecycle operations, and exposes operational results to client apps; the README also documents routing, fleet telemetry, pricing, OCR, reporting, and settlement capabilities. The sampled source confirms the errand and category-inference controller paths, plus routing and authentication internals. Several documented subsystems were not sampled, so their internal links are omitted or marked unverified.
Main entry points: index.ts API routes · errandService.ts Errand services · prisma.ts Prisma data access · categoryInferenceService.ts Category inference
Components 22
API and security
- HTTP API
src/index.ts - API routes
src/routes/index.ts - Authentication
src/middleware/auth.ts
Errand operations
- Errand lifecycle
src/controllers/errandController.ts - Errand services
src/services/errandService.ts - Payments and settlement
src/controllers/errandPaymentController.ts - Reports and exports
src/services/reportService.ts
Location services
- Rider tracking
src/services/trackingService.ts - Routing service
src/lib/routing/resilientRoutingService.ts - Route providers
src/lib/routing/osrmProvider.ts - Firebase services
src/lib/firebaseAdmin.ts
Decision support
- Category inference
src/services/categoryInferenceService.ts - Category sidecar
ml/app.py - Item placement
src/services/itemPlacementService.ts - Receipt OCR
src/lib/ocr/resilientOcrService.ts
Platform services
- Prisma data access
src/lib/prisma.ts - MariaDB
- Session management
src/services/sessionService.ts - Rider presence
src/services/riderPresenceService.ts - Notifications
src/lib/pushNotifications.ts - Scheduled learning
src/jobs/dwellLearning.ts
Other components
- Client apps
Connections 26
- Client apps → HTTP API: calls
README.md - HTTP API → API routes: mounts
src/index.ts - API routes → Errand lifecycle: routes requests
- API routes → Category inference: routes requests
- API routes → Authentication: protects routes
- Errand lifecycle → Errand services: calls
src/controllers/errandController.ts - Errand services → Prisma data access: persists operations
README.md - Prisma data access → MariaDB: reads and writes
README.md - API routes → Payments and settlement: routes requests
- API routes → Reports and exports: routes requests
README.md - API routes → Rider tracking: routes requests
README.md - Rider tracking → Firebase services: streams GPS
README.md - Errand services → Routing service: uses for ETA
README.md - Routing service → Route providers: tries providers
src/lib/routing/resilientRoutingService.ts - API routes → Category inference: routes requests
- Category inference → Category sidecar: requests predictions
src/services/categoryInferenceService.ts - Category inference → Prisma data access: resolves active categories
README.md - Category inference → Item placement: suggests placements
src/controllers/categoryInferenceController.ts - Errand services → Receipt OCR: verifies receipts
README.md - Authentication → Session management: checks session tokens
README.md - Session management → Prisma data access: stores sessions
src/services/sessionService.ts - Authentication → Firebase services: uses identity services
README.md - Errand services → Notifications: notifies participants
README.md - Scheduled learning → Prisma data access: learns from deliveries
README.md - Scheduled learning → Errand services: updates dwell estimates
README.md - Rider presence → Prisma data access: persists presence
src/services/riderPresenceService.ts