shubhsardana29 / SpareLink

SpareLink - an automated Spare Part Planning, Visibility, and Assignment tool

Table of Contents

• Introduction
• Tech Stack
• Database ER Diagram
• Prerequisites
• Backend Setup
  • 1. Go to the Backend Directory
  • 2. Configure the Backend
  • 3. Build and Run
• Frontend Setup
  • 1. Go to the Frontend Directory
  • 2. Build and Run
• Backend API Endpoints

Introduction

SpareLink is a comprehensive software solution designed to streamline spare part planning, visibility, and assignment for aftersales stakeholders. It enables efficient spare part management for service centers, planning teams, warehouse teams, and customer support, ultimately improving customer experience and reducing manual material allocation.

We.are.mp4

Watch our Introductory Video to see how SpareLink can transform your aftersales process.

Tech Stack

Backend (Java Spring Boot)

• Java
• Spring Boot
• Maven
• MySQL

Frontend (React)

• React:
• Tailwind CSS
• Yarn

Database ER Diagram

Prerequisites

Before you begin, ensure you have met the following requirements:

• Java Development Kit (JDK)
• Apache Maven
• Node.js
• Yarn

Clone the Repository:

git clone https://github.com/shubhsardana29/SpareLink.git
cd SpareLink

Backend Setup

1. Go to the Backend Directory

cd SpareLink_backend

2. Configure the Backend

In the SpareLink_backend/src/main/resources directory, you'll find the application.properties file. Open this file and configure the database connection settings according to your setup. Replace the following placeholders:

• ${DATABASE_HOST}: Replace with your database host.
• ${DATABASE_PORT}: Replace with your database port.
• ${DATABASE_NAME}: Replace with your database name.
• ${DATABASE_USERNAME}: Replace with your database username.
• ${DATABASE_PASSWORD}: Replace with your database password.

3. Run

./mvnw spring-boot:run

The backend will run at http://localhost:8080.

Frontend Setup

1. Go to the Frontend Directory

cd SpareLink_frontend

2. Build and Run

yarn install
yarn dev

The frontend will run at http://localhost:5173.

Backend API Endpoints

• http://localhost:8080/api/users: Create new user.
• http://localhost:8080/login: Login User.
• http://localhost:8080/api/get-role: Get user team/role.
• http://localhost:8080/getpartrequests: Get part requests for a particular service center.
• http://localhost:8080/getallpartrequests: Get All part requests for planning team.
• http://localhost:8080/getalljobsheets: Get all jobsheets for a particular service center.
• http://localhost:8080/createjobsheet: Create new jobsheet for a service center user.
• http://localhost:8080/createpartrequest: Create new part request from service center.