This project is a part of the Advanced API Development course (ITS1114) for the Graduate Diploma in Software Engineering. It aims to develop an enterprise-level application using Spring Framework, specializing in Spring Boot and MySQL, for Hello Shoes Pvt. Ltd.
- Introduction
- System Overview
- Project Structure
- System Requirements
- Tech Stack
- Installation
- Usage
- ER Diagram
- Class Diagram
- Client Directory
- Server Directory
- Contributing
- License
Hello Shoes Pvt. Ltd is a shoe retail company with multiple branches. This project aims to systemize various aspects of their operations including sales, inventory management, customer management, employee management, and admin panel functionalities.
The system consists of several microservices to handle different aspects of the business process:
- Sales Service
- Supplier Service
- Customer Service
- Employee Service
- Inventory Service
- Admin Panel Service
- User Service
The project follows a modular structure with each microservice housed in its own module. The structure is as follows:
sales-service
supplier-service
customer-service
employee-service
inventory-service
admin-panel-service
user-service
Please refer to the Course Work document for detailed system requirements and instructions.
The project utilizes the following technologies:
- Front End:
- HTML, CSS, JavaScript, jQuery, AJAX
- Back End:
- Spring Boot, Spring Data, Spring Web MVC, Spring Validation, Spring Security, Lombok, Model Mapper, Jackson
- Database:
- MySQL
- Authentication:
- JWT
- Documentation:
- Swagger
- Clone the repository:
git clone https://github.com/your_username/HelloShoesPVT.git
- Navigate to the project directory:
cd HelloShoesPVT
- Build the project:
mvn clean install
- Start each microservice individually using
mvn spring-boot:run
command. - Access the different functionalities using the provided endpoints.
You can find the ER diagram here.
You can find the class diagram here.
The client-side code is located in the client
directory.
The server-side code is located in the server
directory.
Contributions are welcome! Please open an issue or submit a pull request with your suggestions or improvements.
This project is licensed under the MIT License.