Welcome to the GitHub organization for the Restaurant Management System project.
This organization is used to coordinate development, share project resources, and maintain the code and documentation for a role-based restaurant operations platform.
Build a practical web application that brings restaurant administration, HR, finance, employee self-service, kitchen order processing, and customer ordering into one system.
| Role | Main Responsibilities |
|---|---|
| Admin | System overview, employee management, user management, and menu management |
| Finance | Income and expense overview, transaction history, and manual expense entry |
| HR | Attendance records and leave-request review |
| Employee | Personal profile, attendance history, and leave requests |
| Kitchen Staff | View incoming orders and move them through valid preparation statuses |
| Customer | Browse menu items, manage cart, place orders, and track orders |
- Frontend: Next.js-compatible web interface
- Backend: ASP.NET Core
- Authentication and authorization: ASP.NET Core Identity
- Database: MySQL
The exact frontend libraries and project structure may change as implementation progresses. Repository documentation should reflect the technologies actually in use.
- Separate navigation and permissions for each role.
- Consistent, accessible, responsive UI components.
- Clear tables, forms, filters, and status indicators.
- Useful loading, empty, error, validation, and success states.
- Backend-enforced authorization and validation.
- Reusable components and maintainable code.
- Documentation that stays aligned with the current implementation.
Add links below as repositories are created.
- Application repository: Add repository URL
- UI/UX designs and assets: Add repository URL, if maintained separately
- Project documentation: Add repository URL, if maintained separately
- Review the issue or task before starting work.
- Create a branch for the feature or fix.
- Keep commits focused and use descriptive messages.
- Test the affected workflow before opening a pull request.
- Describe the changes and any known limitations in the pull request.
- Never commit credentials, tokens, private connection strings, or other secrets.
The project scope covers the six roles and core workflows listed above. Update this section with milestones, active development areas, and completed features as the project progresses.
For questions, open an issue in the relevant repository or contact the project maintainers through the organization's GitHub page.
