patrick19368/WarehouseRonin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
No description
4 commits 1 branch 0 tags 1.4 MiB
Find a file
Exact
patrick19368 673bff4266 Update README.md
2025-12-19 12:37:22 -05:00
wms-backend first commit 2025-12-12 18:20:33 +00:00
LICENSE.txt first commit 2025-12-12 18:20:33 +00:00
README.md Update README.md 2025-12-19 12:37:22 -05:00

README.md

CipherWorkZ Logo

License Version Python Platform Backend Database


Warehouse Management System (WMS)

A practical and secure system for real-time inventory management, built for growing warehouse operations.

Get Started · Report Bug · Request Feature

Table of Contents

About the Project

The Warehouse Management System (WMS) is built to give operations teams full visibility and control over inventory without relying on cloud vendors or bloated enterprise software. It’s fast to deploy, easy to maintain, and designed for real-world warehousing needs.

WMS Overview

WMS helps your team:

  • Reduce picking errors and manual entry
  • Optimize warehouse layout with location tracking
  • Meet compliance needs through full traceability
  • Scale operations without adding unnecessary tools

Core Capabilities

  • Inventory tracking across boxes, pallets, and shipments
  • Location-based organization with path validation
  • Secure user and permission management
  • Mobile-friendly QR code scanning
  • Built-in system health and data integrity checks

(back to top)

Built With

  • FastAPI
  • PostgreSQL
  • SQLAlchemy
  • Linux systemd
  • Python 3.11+

(back to top)

Getting Started

You can deploy WMS with a single command. It's designed to install on Ubuntu/Debian-based systems and run entirely on your infrastructure.

Prerequisites

  • Python 3.11+
  • PostgreSQL 16+
  • Linux (Ubuntu/Debian)
  • git, pip3, rsync

Initialize the Database

sudo -u wms python3 /opt/wms/init_db.py

This step:

  • Creates admin and default user
  • Applies schema and permission structure
  • Validates the database

Start the Service

systemctl enable wms
systemctl start wms
systemctl status wms

(back to top)

Usage

WMS includes a browser-based interface for tracking and managing all warehouse items.

Here are a few highlights:

Client and Inventory Views
Client
Boxes
Pallets

Locations and Movement
Locations
Move Item

Permissions and Settings
Permissions
Settings

System Monitoring
Health

System endpoints:

  • /api/health (UI)
  • /api/health/json (machine-readable)

(back to top)

Roadmap

  • Multi-warehouse support
  • Barcode printing and label customization
  • Reporting and data exports
  • REST API documentation

(back to top)

Contributing

Pull requests are welcome. For major changes, open an issue first to discuss your ideas.

If you're contributing schema or permission logic, ensure all changes preserve deterministic behavior and system integrity.

(back to top)

License

This project is licensed under the GNUv3.0 License. See LICENSE for details.

(back to top)

Contact

Maintained by the team at CipherWorkZ
Email: patrick-lacasse@outlook.com GitHub: CipherWorkZ/live-wms

(back to top)