Skip to content

README.md

Latest commit

 

History

History
92 lines (66 loc) · 2.9 KB

README.md

File metadata and controls

92 lines (66 loc) · 2.9 KB

📦 Modern Inventory Management System

License Node React Status

A powerful, efficient, and user-friendly inventory management solution designed to streamline product tracking and business operations. Built with a robust Node.js backend and a dynamic React frontend.

View Live Demo

✨ Features

  • 📊 Interactive Dashboard: Real-time overview of total products, stock levels, and store value with beautiful charts (Recharts).
  • 🛡️ Secure Authentication: Role-based access control (Admin/Employee) using JWT and bcrypt.
  • 📦 Product Management: Easy-to-use interface to add, edit, delete, and search for products.
  • 📄 PDF Reporting: Generate professional PDF inventory reports with a single click.
  • 🎨 Modern UI/UX: Responsive design built with Tailwind CSS, Framer Motion animations, and Lucide icons.
  • ⚡ Fast Performance: Powered by Vite for lightning-fast frontend updates.

🛠️ Tech Stack

Frontend

  • Framework: React.js
  • Build Tool: Vite
  • Styling: Tailwind CSS
  • Icons: Lucide React
  • Animations: Framer Motion
  • Charts: Recharts
  • HTTP Client: Axios

Backend

  • Runtime: Node.js
  • Framework: Express.js
  • Database: SQLite (Development) / Scalable to PostgreSQL/MySQL
  • ORM: Sequelize
  • Security: Helmet, CORS, Express Validator
  • Authentication: JSON Web Tokens (JWT)

🚀 Getting Started

Follow these steps to set up the project locally.

Prerequisites

  • Node.js (v14 or higher)
  • npm or yarn

Installation

  1. Clone the repository

    git clone https://github.com/KamalElmaddini/inventory-system.git
cd inventory-system

  2. Install Dependencies We have a convenient script to install dependencies for both the root, backend, and frontend.

    npm run install-all

Running the Application

Start both the backend and frontend servers concurrently with a single command:

npm start
  • Frontend: http://localhost:5173
  • Backend API: http://localhost:5000

📸 Screenshots

Inventory Management System

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/AmazingFeature)
  3. Commit your changes (git commit -m 'Add some AmazingFeature')
  4. Push to the branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

📝 License

This project is licensed under the MIT License - see the LICENSE file for details.

© 2026 Kamal Elmaddini. All Rights Reserved.