Skip to content

caicedov/multi-store-inventory-management

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

Multi Store Inventory Management

A modern web application for managing inventory across multiple store locations.
Explore the docs »

View Demo (Work-In-Progress) · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

💻About The Project

This project is a modern Next.js 15 web application designed to streamline inventory management across multiple store locations. It allows businesses to efficiently track stock levels, manage inter-store transfers, and record sales with ease.

Key Features:

  • Role-based access control (RBAC) for admin and seller roles
  • Inventory tracking for multiple stores
  • Secure, protected routes for managing stock
  • Real-time updates and movement history
  • Responsive design adaptable to desktop, tablet, and mobile

🚀Built With

  • Next
  • TypeScript
  • Tailwind CSS
  • Prisma
  • PostgreSQL
  • Biome

(back to top)

⚡️Getting Started

To get a local copy up and running, follow these steps.

🔨 Prerequisites

You will need Node.js and npm installed. You can check if you have them installed by running:

node -v
npm -v

If you don't have them installed, you can download them from here.

⚙️ Installation

  1. Clone the repository:
git clone https://github.com/caicedov/multi-store-inventory-management.git
  1. Navigate to the project directory:
cd multi-store-inventory-management
  1. Install the dependencies:
npm install
  1. Create a .env file in the root directory and add the following variables:
DATABASE_URL=postgresql://user:password@localhost:5432/database

(back to top)

🧪Usage

To run the application, use the following command:

npm run dev

The application will be available at http://localhost:3000.

Examples (Work-In-Progress section)

(back to top)

🎯 Roadmap

Essential features

  • User authentication
  • Role-based access control (RBAC)
  • Inventory Tracking for Multiple Stores
  • Secure, Protected Routes for Inventory Management
  • Recording and Tracking Inter-Store Transfers
  • Sales Registration for Products
  • Responsive Design for Desktop, Tablet, and Mobile
  • Real-Time Updates and Movement History

Optional features

  • Batch Operations Support for Inventory Management
  • Product Categorization for Enhanced Organization
  • Low Stock Alerts via Notifications
  • Analytics Dashboard for Inventory Insights
  • Export Functionality (CSV, Excel, etc.) for Reports
  • Search and Filter Options for Products
  • Advanced Reporting Features (Sales Reports, Stock Movement Reports)
  • User Activity Logs for Tracking Changes

See the open issues for a list of proposed features (and known issues).

👍 Contributing

Contributions are what make the open-source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  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

(back to top)

🧾 License

Distributed under the MIT License. See LICENSE for more information.

(back to top)

📥Contact

Victor Caicedo - @soyelparce_ - [email protected]

Project Link: https://github.com/caicedov/multi-store-inventory-management

(back to top)

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published