Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/JFKoryy/autopart-pro/llms.txt

Use this file to discover all available pages before exploring further.

AutoPart Pro is an open-source inventory and e-commerce platform built for automotive parts businesses. It combines a role-based REST API (Node.js + Express + MySQL) with a React frontend, giving admins, employees, and customers a tailored experience from one unified system.

Quickstart

Get the backend and frontend running locally in under 10 minutes.

API Reference

Explore all REST endpoints — auth, products, sales, and user management.

Architecture

Understand the MVC structure, database schema, and request lifecycle.

Features

Inventory management, checkout, role-based access, and stock alerts.

​
What AutoPart Pro Provides

AutoPart Pro covers the full lifecycle of an automotive parts business — from stocking shelves to completing customer orders.

Inventory Management

Full product CRUD with SKU tracking, categories, brands, and compatible vehicle lists.

Sales & Checkout

Transactional checkout that records sales and automatically deducts stock.

Role-Based Access

Three roles — admin, employee, client — each with scoped permissions.

Stock Alerts

Real-time low-stock notifications via Node.js EventEmitter with configurable thresholds.

JWT Authentication

Stateless auth with signed JWT tokens and bcrypt password hashing.

REST API

Decoupled Express API ready to integrate with any frontend or third-party client.

​
Getting Started

1

Clone the repository

git clone https://github.com/JFKoryy/autopart-pro.git
cd autopart-pro
2

Configure environment variables

Create a .env file in the backend/ directory with your MySQL credentials and JWT secret. See Environment Variables for the full reference.
3

Initialize the database

Run the provided SQL script against your MySQL 8+ instance to create all tables and seed the schema.
mysql -u root -p < backend/database.sql
4

Start backend and frontend

# Terminal 1 — backend
cd backend && npm install && npm run dev

# Terminal 2 — frontend
cd frontend && npm install && npm run dev
The API will be available at http://localhost:5000 and the frontend at http://localhost:5173.
Check the Quickstart guide for a complete walkthrough including your first API call and login flow.

Build docs developers (and LLMs) love

Get started for freeTalk to us