How amit-ashok-swain/restaurant-management-system works
Project type and purpose
• This is a Spring Boot–based backend service providing RESTful CRUD operations for a restaurant management system. It exposes endpoints for three user roles (Admin, User, Visitor) and integrates with a MySQL database plus external JavaMail email service.
File structure
• Top‑level modules:
• Restaurant‑Management‑Service‑API – the main Spring Boot application (Controller, Service, Repository layers).
• (Other folders appear to be older or alternative implementations; focus on the Service‑API module.)
• Layered organization under src/main/java/com/geekster/.../RestaurantManagementServiceAPI:
• Controller – HTTP endpoints
• DTO – request/response payloads
• Model – JPA @Entity classes
• Repository – Spring Data JPA interfaces
• Service – business logic
• Resources: application.properties (DB, mail, security), Swagger (SpringDoc) configuration.
Key architectural insights from the README
• Layered (MVC‑style) monolith: Controllers → Services → Repositories → MySQL
• Role‑based access control via Spring Security
• JavaMail API for outgoing emails
• Swagger UI for API documentation
Main components
a. Clients & entry points
• Admin client (e.g., Postman or UI)
• User client
• Visitor client
• Swagger UI documentation
b. API Layer
• Controllers (FoodController, OrderController, UserController, VisitorController, AdminController)
c. Business Logic Layer
• Service classes (FoodService, OrderService, UserService, VisitorService, AdminService, AuthenticationService)
d. Data Access Layer
• Spring Data Repositories (IFoodRepo, IOrderRepo, IUserRepo, IVisitorRepo, IAdminRepo, IAuthenticationRepo)
e. Persistence
• MySQL Database
• Tables: User, FoodItem, Order, AuthenticationToken
f. External services
• JavaMail SMTP server (EmailHandler)
g. Supporting services
• Spring Security component enforcing JWT/session authentication
• SpringDoc OpenAPI (Swagger)
Relationships and data flows
• Clients → HTTP request → Controllers
• Controllers → invoke Service methods (business rules, validation)
• Services → call Repositories → persist/fetch Entities from MySQL
• AuthenticationService ↔ IAuthenticationRepo ↔ AuthenticationToken table
• UserService ↔ IUserRepo ↔ User table
• OrderService ↔ IOrderRepo ↔ Order table
• FoodService ↔ IFoodRepo ↔ FoodItem table
• AdminService ↔ IAdminRepo & IFoodRepo
• Services send emails via JavaMail API
• Swagger UI → introspects Controllers for interactive API docs
Architectural patterns & design principles
• Layered architecture (Controller → Service → Repository)
• Separation of concerns: Controllers handle HTTP and DTOs, Services encapsulate business logic, Repositories abstract persistence
• Role‑based access control via Spring Security annotations
• DTO patterns to decouple API payloads from Entity classes
• Externalized configuration via application.properties