A modern and efficient solution for managing daily meal bookings.
The Lunch Booking System is a robust and scalable RESTful application built with Java and Spring Boot. It's designed to streamline the process of booking and managing daily lunches for organizations of all sizes.
This project is built with a focus on code quality, security, and maintainability. We use GitHub Actions for CI/CD and SonarCloud for continuous code quality analysis.
Our comprehensive wiki is the central hub for all project documentation. It's the best place to get a deep dive into the project's architecture, features, and API.
| Page | Description |
|---|---|
| 🏠 Wiki Home | The main landing page for all our documentation. |
| 📖 User Stories | Understand the application's features from the perspective of different users like Employees, Managers, and Caterers. |
| 🏗️ Entity Design | Explore the database schema with detailed diagrams and explanations of each table and their relationships. |
| 🔌 API Specifications | A complete reference for every API endpoint, including request/response examples and authentication details. |
This project is built with a modern and robust technology stack:
To get a local copy up and running, please follow these simple steps.
- Java 17
- Maven
- Docker (optional)
- Clone the repo
git clone https://github.com/ohbus/lunch-booking-backend.git
- Navigate to the project directory
cd lunch-booking-backend - Run the application
mvn spring-boot:run
The application will then be available at http://localhost:8080. For details on how to use the API, please see our API Specifications in the wiki.
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
Wiki is the best place to start contributing. You can help us by:
- Improving Documentation: If you find any part of the documentation unclear or missing, feel free to edit the wiki pages.
- Adding Features: If you have an idea for a new feature, please check the existing issues to see if it's already being worked on. If not, you can propose it in the wiki or open a new issue.
- Fixing Bugs: If you find a bug, please report it in the issues section. If you can fix it, feel free to submit a pull request.
- Code Quality: Help us maintain high code quality by reviewing pull requests and suggesting improvements.
- Testing: Write tests for new features or improve existing tests to ensure the application remains stable.
- Security: If you find a security vulnerability, please report it privately to us via email at [
You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
Distributed under the GNU Affero General Public License v3.0. See LICENSE for more information.