This workspace contains the Smart Restaurant System, a multi-application platform consisting of four interconnected repositories. This document serves as the central navigation guide to all project documentation.
The Github organization hosting this workspace is: https://github.com/K23-Smart-Restaurant
The demo video can be found on Youtube: https://youtu.be/l-kez8bRPS0
The comprehensive system documentation is located in the smart-restaurant-root repository:
Smart Restaurant Root - Main README
This is the primary reference document containing complete system information, setup instructions, architecture, and operational guides.
The smart-restaurant-root/docs/general directory contains essential system-wide documentation:
- ARCHITECTURE.md - System architecture and design principles
- DATABASE_DESIGN.md - Database schema and relationships
- DATABASE_SETUP.md - Database installation and configuration
- SETUP.md - System setup and deployment instructions
- USER_GUIDE.md - User guide and operational procedures
- CICD.md - Continuous integration and deployment guidelines
The workspace is organized into four primary directories:
Directory: smart-restaurant-root
Purpose: Shared database schema, migrations, Docker orchestration, and system-wide documentation
Documentation: smart-restaurant-root/docs
Directory: smart-restaurant-admin
Purpose: Restaurant management and kitchen display system
Documentation: smart-restaurant-admin/docs
Key documentation files:
- API_REFERENCE.md - Admin API endpoints
- ARCHITECTURE.md - Application architecture
- DATABASE_DESIGN.md - Database schema reference
- SETUP.md - Installation guide
- USER_GUIDE.md - Admin application user guide
Directory: smart-restaurant-customer
Purpose: Customer-facing QR ordering and payment application
Documentation: smart-restaurant-customer/docs
Key documentation files:
- API_REFERENCE.md - Customer API endpoints
- ARCHITECTURE.md - Application architecture
- DATABASE_DESIGN.md - Database schema reference
- SETUP.md - Installation guide
- USER_GUIDE.md - Customer application user guide
Directory: smart-restaurant-super-admin
Purpose: Platform administration and multi-tenant management
Documentation: smart-restaurant-super-admin/docs
Key documentation files:
- API_REFERENCE.md - SuperAdmin API endpoints
- ARCHITECTURE.md - Application architecture
- DATABASE_DESIGN.md - Database schema reference
- SETUP.md - Installation guide
- USER_GUIDE.md - SuperAdmin user guide
Development activity and code metrics for each application:
- Admin Statistics - Commit history and code counts
- Customer Statistics - Commit history and code counts
- SuperAdmin Statistics - Commit history and code counts
Begin with smart-restaurant-root/README.md and refer to SETUP.md for comprehensive setup instructions.
Consult ARCHITECTURE.md for system-wide architecture and individual application architecture documents in their respective docs/ folders.
Reference DATABASE_DESIGN.md for the complete database schema and DATABASE_SETUP.md for installation procedures.
Refer to the API_REFERENCE.md file in each application's documentation folder for endpoint specifications and usage examples.
Access the USER_GUIDE.md in the relevant application's documentation folder for operational instructions.
Last Updated: January 19, 2026
