/HelloShoesPVT

Primary LanguageJavaScriptMIT LicenseMIT

Hello Shoes Pvt. Ltd - Shoe Shop Management System

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.

Table of Contents

  1. Introduction
  2. System Overview
  3. Project Structure
  4. System Requirements
  5. Tech Stack
  6. Installation
  7. Usage
  8. ER Diagram
  9. Class Diagram
  10. Client Directory
  11. Server Directory
  12. Contributing
  13. License

Introduction

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.

System Overview

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

Project Structure

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

System Requirements

Please refer to the Course Work document for detailed system requirements and instructions.

Tech Stack

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

Installation

  1. Clone the repository: git clone https://github.com/your_username/HelloShoesPVT.git
  2. Navigate to the project directory: cd HelloShoesPVT
  3. Build the project: mvn clean install

Usage

  1. Start each microservice individually using mvn spring-boot:run command.
  2. Access the different functionalities using the provided endpoints.

ER Diagram

You can find the ER diagram here.

Class Diagram

You can find the class diagram here.

Client Directory

The client-side code is located in the client directory.

Server Directory

The server-side code is located in the server directory.

Contributing

Contributions are welcome! Please open an issue or submit a pull request with your suggestions or improvements.

License

This project is licensed under the MIT License.