The Multi-Tenancy Hostel Management System is a robust, web-based application designed to simplify and optimize the management of private hostels within educational institutions. Our system offers a seamless experience by efficiently handling hostel allocation, student registration, and staff management tasks. This comprehensive solution empowers administrators, hostel staff, and students to carry out their responsibilities with ease, ensuring a streamlined and hassle-free hostel management process.
Before you begin, ensure you have the following prerequisites installed:
- Java 17
- Spring 6
- Spring Boot 3
- Spring Security
- MySQL database
- Gradle Groovy
In educational institutions, the management of hostels is often plagued by inefficiencies and complexities. Manual processes for hostel allocation, student registration, and staff management can lead to errors, delays, and administrative challenges. Without a centralized and user-friendly system, administrators, hostel staff, and students face difficulties in coordinating and executing their respective tasks, which can hinder the smooth operation of hostel facilities and lead to dissatisfaction among stakeholders.
The need for a solution arises from the following problems:
-
Inefficient Hostel Allocation: The current manual system for allocating hostel rooms is time-consuming and prone to errors, resulting in suboptimal room assignments and dissatisfaction among students.
-
Booking Inconvenience: Often, learners waste precious time looking for hostels, especially during exams, which reduces study time and can lead to subpar academic performance.
-
Funds Embezzlement: There have been issues in recent years where guardians fell victim to embezzlement from their wards.
-
Tedious Student Registration: The process of registering students for hostel accommodation is cumbersome, often requiring excessive paperwork and administrative effort.
-
Lack of Transparency: Without a centralized system, there is a lack of transparency in the allocation and management of hostel resources, leading to disputes and confusion among stakeholders.
The Multi-Tenancy Hostel Management System seeks to address these challenges by providing an integrated and user-friendly platform that automates key processes, enhances transparency, and ensures a smooth and efficient hostel management experience for all stakeholders.
- Dependencies
- Installation
- Database Configuration
- JSON Web Token Configuration (JWT)
- Mail Configuration
- Usage/Examples
- Key Highlights / Uniqueness
- Challenging Moments
- Further Improvements
- Special Gratitude
- Author
The following dependencies are required:
- Spring Web
- Spring Data Jpa
- Spring WebFlux
- Project Lombok
- Spring Validation
- Http Client
- Spring Doc & Open API
- Java Mail Service
- Spring Security
- JSON Web Token (JWT)
- MySQL
- Spring Boot Dev Tools
- Clone the repository to your local machine:
git clone https://github.com/moseshunsu/hngx-stage-two - Build the project.
- Configure the application.
The configuration for this API is stored in the application.properties file. To configure the API or make changes to its behavior, you can edit this file.
spring.datasource.url=your-database-url
spring.datasource.username=root
spring.datasource.password=
spring.jpa.hibernate.ddl-auto=update
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.jpa.properties.hibernate.dialect=org.hibernate.dialect.MySQLDialectapplication.security.jwt.secret-key=
application.security.jwt.expiration=
application.security.jwt.refresh-token.expiration=spring.mail.host=smtp.gmail.com
spring.mail.port=587
spring.mail.username=your-email
spring.mail.password=google-given-password
spring.mail.properties.mail.smtp.auth=true
spring.mail.properties.mail.smtp.ssl=true
spring.mail.properties.mail.smtp.starttls.enable=trueThis project has a well-documented OpenAPI (Swagger) interface, which can be accessed here
- This software prioritizes security by requiring user email verification before allowing login.
- Special features, such as password reset for forgotten passwords and password changes for authenticated users, have been implemented.
- Emails are generated upon successful hostel booking.
- Due to the complexity of multi-tenant applications, unique codes have been generated to handle complex routing efficiently.
- Tight mappings have been minimized through the use of Java 8 streams and lambda expressions.
- The software enforces strong password verification, including a minimum length of 8 characters, a maximum length of 16 characters, and the inclusion of special characters.
- Users can easily search for registered hostels in their respective schools and book rooms directly from the site.
- This software is built on Java 8 features, utilizing streams and lambda expressions.
- Sample test cases for Quality Assurances as the software was built based on best practices
- Possible Exceptions that may arise has been catered for in the Application Exception Handler Class
- Building this application required analytical skills similar to those needed for platforms like Jumia or Udemy, due to complex routing.
- Implementing the logic that allows hostel managers to approve bookings of occupants upon successful payment was a challenging task.
The project could benefit from a dedicated service for managing full hostel staffs.