CULINARY-BLISS
Culinary Bliss, a estaurant management app designed to streamline your operations and elevate your dining experience. Whether you own a bustling city bistro or a cozy countryside cafΓ©, Culinary Bliss is your go-to solution for efficient, effective, and effortless restaurant management.
Developed with the software and tools below.
Quick Links
Overview
Welcome to the restaurant management backen! This repository contains a robust and scalable backend system built using Go and the Gin framework, designed to support a comprehensive restaurant management platform. The system is structured to provide secure authentication, user management, and administrative functionalities, ensuring a seamless and efficient operation of a restaurant.
Features
This restaurant management backend, built with Go and Gin, provides robust and scalable functionalities to support a full-fledged restaurant management. The backend includes the following key features:
JWT Authentication
Secure Authentication: Implemented JWT (JSON Web Token) for secure and stateless user authentication.
Token Generation: Generate tokens for user sessions upon successful login.
Token Verification: Verify tokens for protected routes to ensure only authenticated users can access certain endpoints.
Refresh Tokens: Support for refreshing tokens to maintain secure sessions.
Admin Section
User Management: Create, read, update, and delete (CRUD) operations for managing user accounts.
Role Management: Assign and manage roles (e.g., admin, staff) to control access levels and permissions.
Restaurant Management: Manage restaurant details, including name, location, hours of operation, and more.
Global Section
Menu Management: CRUD operations for managing the restaurant menu, including categories, items, prices, and availability.
Reservation Management: Handle customer reservations, including booking, updating, and canceling reservations.
Table Management: Manage table assignments, statuses, and seating arrangements to optimize dining space.
User Section
User Registration and Login: Allow users to register and log in securely.
Profile Management: Users can update their profiles, including personal details and preferences.
Reservation Booking: Users can book, view, and cancel reservations.
Repository Structure
βββ culinary-bliss/
βββ LICENSE
βββ README.md
βββ controllers
β βββ authControllers.go
β βββ categeoryControllers.go
β βββ foodControllers.go
β βββ invoiceControllers.go
β βββ menuControllers.go
β βββ orderControllers.go
β βββ orderItemControllers.go
β βββ restaurantControllers.go
β βββ tableControllers.go
β βββ userControllers.go
βββ culinary-bliss
βββ database
β βββ databaseConnection.go
βββ docs
β βββ docs.go
β βββ swagger.json
β βββ swagger.yaml
βββ go.mod
βββ go.sum
βββ helpers
β βββ adminHelper.go
β βββ tokenHelper.go
βββ main.go
βββ middleware
β βββ authMiddleware.go
βββ models
β βββ categoryModel.go
β βββ foodModel.go
β βββ invoiceModel.go
β βββ menuModel.go
β βββ orderItemModel.go
β βββ orderModel.go
β βββ restaurantModel.go
β βββ tableModel.go
β βββ userModel.go
βββ routes
β βββ authRouter.go
β βββ catgeoryRouter.go
β βββ foodRouter.go
β βββ globalRouter.go
β βββ invoiceRouter.go
β βββ menuRouter.go
β βββ orderItemRouter.go
β βββ orderRouter.go
β βββ restaurantRouter.go
β βββ tableRouter.go
β βββ userRouter.go
βββ types
βββ category-type.go
βββ invoice-type.go
βββ menu-type.go
βββ restaurant-type.go
βββ table-type.go
βββ user-type.go
Modules
helpers
middleware
types
database
models
routes
controllers
Getting Started
Requirements
Ensure you have the following dependencies installed on your system:
Installation
- Clone the culinary-bliss repository:
git clone https://github.com/ShahSau/culinary-bliss
- Change to the project directory:
cd culinary-bliss
- Install the dependencies:
go build -o myapp
Running culinary-bliss
Use the following command to run culinary-bliss:
./myapp
Tests
To execute tests, run:
go test
Project Roadmap
-
βΊ API Testing
-
βΊ Docker
-
βΊ CI/CD
License
This project is protected under the MIT License. For more details, refer to the LICENSE file.