WMS Order Viewer

A warehouse management system (WMS) order viewer web application that allows warehouse managers to search, filter, and sort customer orders.

Features

• 🔍 Search orders by customer username
• 🏷️ Filter orders by status (Pending, Processing, Shipped, Completed, Cancelled)
• 📅 Sort orders by order date or shipment date
• 📦 View detailed order information including items and shipments

Quick Start

For detailed setup instructions, see Quickstart Guide (~15 minutes).

Prerequisites

• Python 3.11+
• Node.js 18+
• Git

Quick Setup

Backend:

cd backend
python -m venv venv
venv\Scripts\activate  # Windows
pip install -r requirements.txt
cp .env.example .env
python seed_database.py
uvicorn main:app --reload

Frontend:

cd frontend
npm install
cp .env.example .env
npm run dev

Access the app at http://localhost:5173

Tech Stack

Backend:

• FastAPI 0.104+
• SQLAlchemy 2.0+
• SQLite 3.x
• Pydantic 2.5+

Frontend:

• React 18
• TypeScript 5.x
• Vite 5.x
• Tailwind CSS 3.x
• React Query 5.x

Documentation

The full specification and technical documentation can be found in the specs/1-wms-order-viewer/ directory:

• Quickstart Guide (~15 min setup) - Step-by-step setup instructions, troubleshooting, demo data
• Feature Specification - User stories, functional requirements, success criteria
• Implementation Plan - Technical architecture, technology stack choices, project structure
• Data Model - Database schema, entity relationships, validation rules, sample data
• API Specification - OpenAPI 3.0 REST API contract with request/response examples
• Task Breakdown - Complete implementation task list with dependencies

Development

Run tests:

# Backend
cd backend
pytest

# Frontend
cd frontend
npm test

Code quality:

# Backend
black . && flake8 . && mypy .

# Frontend
npm run lint && npm run format

Demo Users

• john.doe (22 orders)
• jane.smith (3 orders)
• bob.wilson (2 orders)
• alice.chen (1 order)

License

MIT