Skip to content

README.md

Latest commit

 

History

History
96 lines (60 loc) · 2.42 KB

README.md

File metadata and controls

96 lines (60 loc) · 2.42 KB
Raw

🧭 InventoHub

A full-stack Inventory Management Platform built with Node.js, Express, React, and MongoDB. Easily manage products, categories, and track inventory with a modern, user-friendly interface.

🚀 Features

  • 🔐 JWT Authentication — Secure login & registration with role-based access (Admin/User)
  • 📦 Product Management — Add, view, update, and delete products with category linking
  • 🏷️ Category Management — Organize products using custom categories
  • 🔍 Search & Filter — Find products by name, description, or category
  • 📊 Pagination — Efficient pagination for large product lists
  • 🎨 Modern UI — Responsive, clean interface built with React + Vite
  • 📝 Structured Logging — Integrated Winston logging (console + file)

⚙️ Prerequisites

Ensure the following are installed before setup:

  • Node.js (v18 or higher)
  • npm (v9 or higher)

Verify installation:

node --version
npm --version

🧩 Quick Start Guide

1️⃣ Extract the Project

  1. Clone the repository
  2. Open the folder named InventoHub.

2️⃣ Configure Environment Variables

Inside the root folder (InventoHub), create a file named .env and add:

PORT=5000
MONGO_URI=mongodb+srv://Parkavi:PsZwjnTqv0riojRV@cluster0.uoorwrr.mongodb.net/?appName=Cluster0
JWT_SECRET=4f6ad4f54bd587b501e0d593b7ee6eb6e2ef0768f673c960b0c17c0595013712355ede0a0578284868914c0afcbf6bd76acb048ab6faaa455bb61d024f661c44

3️⃣ Install Backend Dependencies

cd InventoHub
npm install

Start the backend server:

npm run dev

4️⃣ Install Frontend Dependencies

cd InventoHub and then cd frontend
npm install

Start the frontend development server:

npm run dev

5️⃣ Open the Application

Once both servers are running, open your browser and go to:

👉 http://localhost:5173

🧑‍💼 Demo Login Credentials

You can use the following demo accounts to explore the application:

Role Email Password
Admin parkaviparkavi15@gmail.com 8ShT*x8d4EAn#ga
User parkavimuthukrishnan@gmail.com BWcc.6rxdn.3zJc

⚠️ Note: These are demo credentials for testing purposes only. Please do not change or misuse these accounts.