Welcome to the Coffee and Happiness! This project is a comprehensive cafe management system built using Spring Boot, Next.js, and Kotlin for Android. This README.md will provide an in-depth overview of the project's structure, features, and functionality.
- Introduction
- Features
- Roles
- Food Management
- Cafe Management
- Review System
- Order System
- Bonus Points
- News
- Technologies Used
- Project Structure
- Usage
- Authors
- Contributing
- License
The Cafe Application is designed to streamline the operations of a cafe, providing functionality for managing orders, inventory, and customer interactions. It consists of three major components:
- Backend Logic (Spring Boot): This component handles the server-side logic, including order processing, inventory management, user authentication, and more.
- Web Application (Next.js): The web interface allows cafe staff to take orders, manage inventory, and view customer information. Users can also interact with the cafe through the website.
- Android Application (Kotlin): The Android app enables mobile access to the cafe's functionality, allowing staff to process orders on the go, and customers to place orders and explore cafe options.
The application supports three roles:
- User: Regular cafe visitors who can place orders, review food, and cafes.
- Waiter: Staff members responsible for creating orders, scanning user QR codes, and processing requests.
- Admin: Administrators who can manage food items, cafes, news, and more.
- Menu Display: Food items are displayed in both the application and website menu sections.
- Institutions Display: Cafes are displayed as institutions with coordinates on maps. Users can choose between viewing the list of institutions or using the map with cafe markers.
- Rating and Reviews: Users can rate and write reviews for both food items and cafes. The average rating is displayed as stars in menus and institution details.
- User Reviews: Users can view and manage their own reviews on their profile page.
- Waiter-User Interaction: Waiters can create orders in real-time based on customer requests. Users place orders through waiters who scan their QR codes.
- Order History: Users can view their order history in their profile.
- Reward Mechanism: Users receive bonus points equal to the order price for each order. These points can be used for future orders, with a cost multiplier of x10.
- News Section: News and updates are displayed in both the application and website.
- Spring Boot: Backend logic, RESTful API development, authentication with Spring Security and JWT.
- Spring Data JPA: For data access and management.
- Hibernate: As the JPA provider.
- Next.js: Frontend web application development and menu display.
- Kotlin: Android application development with real-time order processing.
- Database: MySQL hosted in Azure.
- Authentication: User authentication with Spring Security and JWT, including role-based access control.
- Azure Services:
- Azure App Services for hosting both backend and frontend.
- GitHub Actions for CI/CD for backend.
- Azure DevOps Pipelines for CI/CD for frontend.
- Azure Storage for saving images of food, user profile, cafe, and news.
- Azure Storage for hosting the Android APK file, which can be downloaded from the website.
-
JUnit: We use JUnit, a widely-used testing framework for Java applications, to create and run unit tests for our Spring Boot backend. JUnit enables us to test individual components and functions to ensure they work as expected.
-
Mockito: Mockito is a popular mocking framework that complements JUnit. We use Mockito to create mock objects and simulate interactions between various parts of our application during testing. This helps us isolate and verify the behavior of specific components without relying on real implementations.
Our testing approach ensures that the CoffeeAndHappiness application maintains high-quality standards and reliability in the backend logic. It is an integral part of our development process to deliver a seamless experience for both cafe staff and customers.
- Tsebulia Denys: Backend developer, DevOps.
- Horak Maksym: Android developer.
- Soloviy Nazariy: Frontend developer.
This project is licensed under the MIT License.