How sahalpk007/my-rms-monorepo works
RMS is a restaurant operations platform with role-specific web dashboards backed by a NestJS API and PostgreSQL. The principal workflow is staff or customer interaction through the routed frontend, authenticated API requests, and domain services that manage orders, menus, kitchen status, and payments. Separate branches cover inventory, staff, ratings, notifications, and operational analytics. The README documents broader capabilities than the sampled code; arrows below are limited to relationships shown in excerpts or explicitly described there.
Main entry points: App.tsx Route and dashboards · useWaiterOrders.ts Waiter order workflow · AuthContext.tsx Auth context · auth.service.ts Auth API service
Components 27
Web application
- Route and dashboards
apps/frontend/src/App.tsx - Auth context
apps/frontend/src/context/AuthContext.tsx - App context
apps/frontend/src/context/AppContext.tsx - Order tracking
apps/frontend/src/pages/OrderTrackingPage.tsx - Waiter order workflow
apps/frontend/src/hooks/useWaiterOrders.ts - API types
apps/frontend/src/lib/types/api.types.ts
Identity and API
- Auth API service
apps/frontend/src/lib/api/auth.service.ts - HTTP API client
apps/frontend/src/lib/api/client.ts - Waiter API service
apps/frontend/src/lib/api/waiter/waiter.service.ts - Socket client
apps/frontend/src/lib/socket/client.ts - Auth endpoints
apps/backend/src/auth/auth.controller.ts - Authentication service
apps/backend/src/auth/auth.service.ts
Restaurant operations
- Order endpoints
apps/backend/src/orders/orders.controller.ts - Order management
apps/backend/src/orders/orders.service.ts - Waiter endpoints
apps/backend/src/waiter/waiter.controller.ts - Waiter workflows
apps/backend/src/waiter/waiter.service.ts - Menu endpoints
apps/backend/src/menu/menu.controller.ts - Menu management
apps/backend/src/menu/menu.service.ts - Kitchen realtime
apps/backend/src/kitchen/kitchen.gateway.ts
Data and administration
- Operational analytics
apps/backend/src/dashboard/dashboard.service.ts - Staff administration
apps/backend/src/staff/staff.service.ts - Inventory management
apps/backend/src/stock/stock.service.ts - Customer ratings
apps/backend/src/ratings/ratings.service.ts - Notifications
apps/backend/src/notifications/notifications.service.ts - Image uploads
apps/backend/src/upload/upload.service.ts - Prisma data access
apps/backend/src/prisma.service.ts
Other components
- Restaurant users
Connections 24
- Restaurant users → Route and dashboards: uses
- Route and dashboards → Auth context: provides routes
apps/frontend/src/App.tsx - Route and dashboards → App context: provides routes
apps/frontend/src/App.tsx - Route and dashboards → Order tracking: routes to
apps/frontend/src/App.tsx - Auth context → Auth API service: calls
apps/frontend/src/context/AuthContext.tsx - Auth API service → HTTP API client: sends requests
apps/frontend/src/lib/api/auth.service.ts - Waiter order workflow → Waiter API service: calls
apps/frontend/src/hooks/useWaiterOrders.ts - Waiter order workflow → Socket client: opens connection
apps/frontend/src/hooks/useWaiterOrders.ts - Waiter API service → HTTP API client: sends requests
apps/frontend/src/lib/api/waiter/waiter.service.ts - Restaurant users → Auth endpoints: authenticates
- Auth endpoints → Authentication service: delegates to
apps/backend/src/auth/auth.controller.ts - Restaurant users → Waiter endpoints: manages orders
- Waiter endpoints → Waiter workflows: delegates to
apps/backend/src/waiter/waiter.controller.ts - Waiter workflows → Prisma data access: queries
apps/backend/src/waiter/waiter.service.ts - Order endpoints → Order management: delegates to
apps/backend/src/orders/orders.controller.ts - Order management → Prisma data access: queries
- Menu endpoints → Menu management: delegates to
apps/backend/src/menu/menu.controller.ts - Restaurant users → Kitchen realtime: receives live updates
- Restaurant users → Operational analytics: views reporting
- Restaurant users → Staff administration: administers staff
- Restaurant users → Inventory management: manages inventory
- Restaurant users → Customer ratings: submits ratings
- Restaurant users → Notifications: uses notifications
- Restaurant users → Image uploads: uploads images