gdsc-uba / hostel-management-sys-sb

Hostel management system backend with spring boot

Hostel Management System

This is a management system for hostels done using Spring boot and thymeleaf. The system stores hostel information such as rooms, residents, prices. It is meant to act as an REST Service for crud operations regarding one or more hostels.

• Built using Java (Spring boot) and thymeleaf on the JRE (Java Runtime Environment).
• This repo is currently maintained by the GDSC-UBa Core Team

Table of Contents

Make sure this is updated based on the sections included:

• Installation
• Getting Started
• Contributing
• Support + Feedback
• Vulnerability Reporting
• License

Installation

This section should outline what is required to install and configure this project. Consider adding:

Prerequisites for use

• LTS version of JDK: Java 8 SDK
• Apache Maven build automation tool: Maven
• Relation DBMS (eg. MySQL, PostgreSQL etc)

Run Local

$ mvn spring-boot:run

Application will run by default on port 8080

Getting Started

• Working with the Hello API
  • Basic Hello World
  • Hello {username}

Contributing

We appreciate feedback and contribution to this repo! Before you get started, please see the following:

• Code of conduct guidelines
• Contribution guide

Support + Feedback

Include information on how to get support. Consider adding:

• Use Issues for code-level support
• Use Community for usage, questions, specific cases

Vulnerability Reporting

Please do not report security vulnerabilities on the public GitHub issue tracker.

License

Link to LICENSE doc.