Skip to content

README.md

Latest commit

 

History

History
99 lines (87 loc) · 3.2 KB

README.md

File metadata and controls

99 lines (87 loc) · 3.2 KB
Raw

WearHouse - Warehouse Management System

WearHouse is a modern, full-stack Warehouse Management System (WMS) designed to streamline inventory tracking, sales, and purchase workflows. It provides a robust dashboard for analytics and comprehensive tools for managing items, warehouses, customers, and suppliers.

🚀 Key Features

  • Dashboard: Real-time analytics and overview of warehouse operations.
  • Inventory Management: Track items, manage categories, and handle stock levels.
  • Warehouse Management: Support for multiple warehouses and stock transfers.
  • Order Management: Full lifecycle support for Sales Orders, Purchase Orders, and Purchase Bills.
  • CRM: Manage Customers and Suppliers efficiently.
  • Stock Adjustments: Tools for inventory corrections and adjustments.
  • User Authentication: Secure JWT-based authentication with user profiles and role management.

🛠️ Tech Stack

Backend

  • Framework: Django & Django REST Framework (DRF)
  • Language: Python
  • Database: PostgreSQL
  • Authentication: JWT (SimpleJWT)
  • Deployment: Gunicorn, WhiteNoise (static files)

Frontend

  • Framework: React 19 (Vite)
  • Styling: Tailwind CSS
  • Animations: Framer Motion
  • Icons: Lucide React & React Icons
  • Charts: Chart.js & React-Chartjs-2
  • Routing: React Router DOM v7
  • Forms: React Hook Form
  • API Client: Axios

📂 Project Structure

WearHouse/
├── Project_WearHouse_Backend/    # Django REST API
│   ├── src/
│   │   ├── Wearhouse/           # Core Django Project
│   │   ├── company/             # Company management app
│   │   ├── customer/            # Customer management app
│   │   ├── manager/             # Warehouse management app
│   │   └── users/               # User & Auth management
│   └── requirements.txt         # Python dependencies
└── Project_WearHouse_Frontend/   # React Application
    └── Wearhouse/
        ├── src/
        │   ├── components/      # Reusable UI components
        │   ├── pages/           # Page-level components
        │   ├── context/          # React Context providers
        │   └── routes/          # Navigation logic
        └── package.json         # JS dependencies

⚙️ Installation & Setup

Prerequisites

  • Python 3.10+
  • Node.js 18+
  • PostgreSQL

Backend Setup

  1. Navigate to the backend directory: 
    cd Project_WearHouse_Backend/src
  2. Create and activate a virtual environment: 
    python -m venv venv
source venv/bin/activate  # On Windows: venv\Scripts\activate
  3. Install dependencies: 
    pip install -r requirements.txt
  4. Configure environment variables (create a .env file based on .env.example).
  5. Run migrations: 
    python manage.py migrate
  6. Start the development server: 
    python manage.py runserver

Frontend Setup

  1. Navigate to the frontend directory: 
    cd Project_WearHouse_Frontend/Wearhouse
  2. Install dependencies: 
    npm install
  3. Start the development server: 
    npm run dev