Skip to content

Latest commit

 

History

History
117 lines (94 loc) · 3.57 KB

README.md

File metadata and controls

117 lines (94 loc) · 3.57 KB
Raw

StoreFlow - Inventory Management System 📦

Welcome to StoreFlow, an Inventory Management System built to streamline the inventory operations. StoreFlow integrates powerful features with a user-friendly interface to provide you with a seamless inventory management experience. 🚀

Features

  1. Login and Signup
  • Secure Authentication: Users can securely log in to the system with their credentials.
  • User Registration: New users can easily sign up for an account to access the platform.
  1. Dashboard
  • Real-Time Analytics: The dashboard provides a real-time overview of key metrics and insights, including sales data, inventory status, and customer trends.
  1. Products Management
  • Product Listing: Easily add, edit, and delete products from the inventory.
  • Categorization: Organize products into categories for efficient management.
  1. Analytics
  • Advanced Reporting: Gain valuable insights into business performance with advanced reporting tools.
  • Sales Trends Analysis: Analyze sales trends over time to make informed business decisions.
  • Inventory Turnover: Monitor inventory turnover rates to optimize stock levels and reduce holding costs.
  1. Customers Management
  • Customer Database: Maintain a comprehensive database of customers, including contact information and purchase history.
  • Customer Segmentation: Segment customers based on various attributes for targeted marketing campaigns.
  1. Inventory Tracking
  • View a history of all the products available in inventory for audit purposes.
  1. Orders Management
  • Order Processing: Manage orders from creation to fulfillment, including order placement, processing, and shipping.
  1. Support
  • Tickets: Raise tickets for any issue faced in inventory which is visible only to Admin.

Technology Stack

  • Frontend: HTML, CSS, JavaScript
  • Backend: Python
  • Frameworks: ReactJS, Django
  • Database: SQLite

Installation

To install and run StoreFlow on your local machine, follow these steps:

Frontend (React)

  1. Clone the repository:
git clone https://github.com/ViplavKhode/StoreFlow.git
  1. Navigate to the project directory:
cd StoreFlow
  1. Install dependencies:
npm install
  1. Start the development server:
npm start
  1. Access StoreFlow Open your preferred web browser and navigate to http://localhost:3000 to access StoreFlow.

Backend (Django)

  1. Create a Virtual Environment (Optional but recommended):
python -m venv env
  1. Activate the Virtual Environment:
  • Windows:
.\env\Scripts\activate
  • macOS/Linux:
source env/bin/activate
  1. Install Django and Django REST Framework:
pip install django djangorestframework
  1. Navigate to the Backend Directory:
cd StoreFlow/api
  1. Run Migrations:
python manage.py migrate
  1. Create a Superuser (Optional):
python manage.py createsuperuser
  1. Start the Django Development Server:
python manage.py runserver

Database (SQLite)

SQLite is included by default with Django. You don't need to perform any additional setup steps for SQLite. Django will create an SQLite database file (db.sqlite3) in the backend directory, and migrations will be applied to this database.

Contributing

Contributions to StoreFlow are welcome! If you'd like to contribute, please fork this repository, make your changes, and submit a pull request.

Contributors