This project is organized as a monorepo:
- client/: Frontend application (React, Vite, Tailwind CSS)
- server/: Backend API (Node.js, Express, MongoDB)
- Node.js (v18 or higher)
- MongoDB (Local or Atlas)
-
Clone the repository
-
Install Dependencies Run this command from the root directory to install dependencies for both client and server:
npm run install-all
-
Environment Setup
- Client: Copy
client/.env.exampletoclient/.env - Server: Copy
server/.env.exampletoserver/.envand update theMONGO_URIif needed.
- Client: Copy
-
Run Development Servers Start both client and server concurrently:
npm run dev
- Client: http://localhost:5173
- Server: http://localhost:5000
- Linting:
npm run lint(Checks both client and server) - Formatting: VS Code is configured to format on save using Prettier.
- Staff Onboarding: Admin ability to create Outlet Managers; Managers creating operational staff.
- Kitchen Dashboard: Real-time order management for kitchen staff.
- Waiter Dashboard: Table management and order status tracking.
- Frontend: React with Context API for state management.
- Backend: Express.js with Controller-Service-Repository pattern.
- Database: MongoDB with Mongoose ODM.