Merge pull request #92 from ttthanhf/readme/update-v1

UPDATE - Update readme file

README.md

@@ -1,6 +1,75 @@
-HouseMate Backend
--
-Port: 8080 <br>
-Java 17 <br>
-Netbean 19 <br>
+# HouseMate - Student House Membership Cart - Backend
+
+<div align="center">
+    <img src="https://housemate.site/assets/logo-7f02d06f.svg" alt="HouseMate" width="100" height="100" />
+    <p><a href="https://housemate.site">HouseMate</a> is a web application that provides service for student apartments.</p>
+</div>
+<br>
+<div align='center'>
+<img src="https://img.shields.io/badge/Java-17-blue"> 
+<img src="https://img.shields.io/badge/Spring%20Boot-3.1.3-blue"> 
+<img src="https://img.shields.io/badge/Build-Passing-green"> 
+<img src="https://img.shields.io/badge/Docker-Yes-green"> 
+<img src="https://img.shields.io/badge/Server-Yes-green"> 
+<img src="https://img.shields.io/badge/API-Yes-green">
+<br>
+</div>
+
+## 0. Introduction
+
+The software system provides service packages for student apartments. Each apartment will purchase pre-designed service packages. Each service may include: hourly service, return service, delivery service, ... Each service package has constraints on usage time, repetition period, number of services per cycle... When used up Services in the package can still be ordered, the price of the additional service depends on the type of service package purchased.
++ Admin can manage individual services, service packages (including individual services)...
++ Staff performs work and updates results of services
++ Customer orders and tracks used services
+
+## 1. Techstacks
+
+<img src="./.github/images/tech-stacks.png" />
+
+## 2. Installation
+
+Clone the repository:
+
+```bash
+git clone https://github.com/ttthanhf/HouseMate-Backend
+```
+
+Add application.properties to resources
+```
+Add application.properties to resources
+```
+
+Maven build
+```
+maven build
+```
+
+Maven run
+```
+maven run
+```
+
+## 3. Infomation
+
+```
+Port: 8080
+Java 17
+Netbean 19
 SpringBoot 3.1.3
+```
+
+## 4. Use case diagram
+
+<img src="./.github/images/use-case-diagram.png" />
+
+## 5. Database Design
+
+<img src="./.github/images/database.png" />
+
+## 6. Team members
+
+-  [Tran Hai Dang](https://github.com/hdang09): Project Leader, Front-end Leader, Back-end Developer
+-  [Tran Tan Thanh](https://github.com/ttthanhf): Back-end Leader
+-  [Lam Thi Ngoc Han](https://github.com/LamHana): Front-end Developer, UI/UX Designer
+-  [Duong Hoang Nam](https://github.com/namdh03): Front-end Developer
+-  [Nguyen Hoang Anh](https://github.com/HanhNg23): Back-end Developer