Welcome to the Hotel Management System repository! This project serves as a comprehensive solution for managing hotel operations. It was developed as part of my Software Engineering course during my Master's Degree in Computer Science and Engineering at the University of Catania.
- Project Overview
- Features
- Technologies Used
- Installation
- Usage
- Contributing
- License
- Contact
- Releases
The Hotel Management System is designed to streamline various hotel operations, including:
- Room booking and management
- Customer management
- Billing and invoicing
- Reporting and analytics
This system provides a user-friendly interface for both hotel staff and guests, ensuring an efficient and pleasant experience.
- User Authentication: Secure login for staff and management.
- Room Management: Easily manage room availability and types.
- Booking System: Simple booking process for guests.
- Billing: Automated billing and invoicing.
- Reporting: Generate reports for occupancy, revenue, and customer data.
This project utilizes a variety of technologies to deliver a full-stack web application. Hereβs a list of the main technologies:
-
Frontend:
- HTML
- CSS (Tailwind CSS)
- JavaScript
-
Backend:
- Java
- Spring Boot
-
Database:
- MySQL
-
Testing:
- JUnit
- Mockito
-
Version Control:
- Git
- GitHub
-
Documentation:
- Markdown
-
Design:
- UML
To get started with the Hotel Management System, follow these steps:
-
Clone the repository:
git clone https://github.com/lesoda-ux/Hotel_Management_System.git
-
Navigate to the project directory:
cd Hotel_Management_System
-
Set up your MySQL database. Create a database named
hotel_management
and import the SQL scripts provided in thesql
folder. -
Configure the application properties in
src/main/resources/application.properties
to match your database settings. -
Build the project using Maven:
mvn clean install
-
Run the application:
mvn spring-boot:run
Once the application is running, you can access it via your web browser at http://localhost:8080
.
- Admin: Has full access to manage users, rooms, and bookings.
- Staff: Can manage room bookings and customer inquiries.
- Guest: Can view available rooms and make bookings.
- Log in as a guest.
- Navigate to the "Book a Room" section.
- Select your desired room type and dates.
- Fill in the required information and confirm your booking.
Admins can generate reports by navigating to the "Reports" section. Choose the type of report you want and specify the date range.
Contributions are welcome! If you would like to contribute to this project, please follow these steps:
- Fork the repository.
- Create a new branch:
git checkout -b feature/YourFeature
- Make your changes and commit them:
git commit -m "Add your message here"
- Push to the branch:
git push origin feature/YourFeature
- Create a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
For any questions or suggestions, feel free to reach out:
- Name: [Your Name]
- Email: [[email protected]]
- GitHub: your-github-profile
To download the latest version of the Hotel Management System, visit the Releases section.
You can find the necessary files to download and execute. Check the release notes for any updates and improvements.
Detailed documentation is available in the docs
folder. It includes:
- System architecture
- API endpoints
- User guides
Thank you for visiting the Hotel Management System repository! Your feedback and contributions are greatly appreciated.