Lager Guru Documentation

Welcome to the complete documentation for Lager Guru, an enterprise-grade warehouse management and transport orchestration system.

Quick Start

• Introduction - What is Lager Guru?
• Product Tour - Guided tour of features
• Key Features - Complete feature list
• Architecture - System architecture
• Deployment Guide - Production deployment
• API Reference - TypeScript API documentation
• Troubleshooting - Common issues and solutions

Features

Core Functionality

• Multi-role System: Admin, Driver, Worker roles with role-based access control
• Real-time Updates: Supabase Realtime for live data synchronization
• PWA Support: Installable, offline-capable progressive web application
• Barcode Scanning: Camera-based barcode scanning for quick order lookup
• GPS Tracking: Live driver location tracking on interactive map
• AI Suggestions: Intelligent driver and zone assignment recommendations
• Shift Management: Weekly/monthly shift scheduling with templates, automatic status sync, and analytics
• Analytics: Real-time KPIs and advanced reporting including shift hours tracking

Enterprise Modules

• Inventory / Stock Management: Complete inventory tracking with stock movements
• Pick & Pack: Enterprise WMS-style picking and packing
• Warehouse Floor Plan: SVG-based zone layout visualization
• Slotting Optimization AI: Intelligent zone placement recommendations
• Maintenance Module: Equipment maintenance tracking
• Safety & Compliance: Incident reporting and analytics
• Equipment Tracking: QR/RFID/manual equipment location tracking
• Auto Assignment Engine: Intelligent driver and zone assignment

See Enterprise Modules for detailed documentation.

Technology Stack

• Frontend: React 18 + TypeScript + Vite
• UI: shadcn/ui + Tailwind CSS
• Backend: Supabase (PostgreSQL + Realtime + Auth)
• Maps: MapLibre GL
• Charts: Recharts
• Deployment: Docker + Nginx

Getting Started

Prerequisites

• Node.js 18+
• npm or yarn
• Supabase account
• Docker (for deployment)

Installation

# Clone repository
git clone https://github.com/your-org/lager-guru.git
cd lager-guru

# Install dependencies
npm install

# Set up environment variables
cp .env.example .env
# Edit .env with your Supabase credentials

# Start development server
npm run dev

Development

# Run development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

# Generate documentation
npm run docs:dev
npm run docs:build

Documentation Structure

docs/
├── overview/            # Product overview and introduction
├── features/            # Enterprise modules and features
├── admin/               # Admin guides and configuration
├── users/               # User guides (workers, drivers)
├── product/            # Product information (pricing, editions, FAQ)
├── api/                 # API documentation
├── database/            # Database reference
├── development/         # Developer guides
├── integrations/        # Integration guides
├── enterprise/          # Enterprise operations
├── security/            # Security documentation
├── deployment/          # Deployment guides
├── multitenant/         # Multi-tenant architecture
├── sso/                 # SSO integration
└── changelog/           # Release notes

Contributing

When adding new features or components:

1. Add JSDoc comments to your TypeScript/React code
2. Update relevant documentation in the docs/ folder
3. Run documentation generation: npm run docs:generate
4. Preview changes: npm run docs:dev

Resources

• Main README - Project overview and setup
• Installation Guide - Detailed installation steps
• Runbook - Operational procedures
• Maintenance Guide - Maintenance checklist

Support

For issues and questions:

• Check Troubleshooting
• Review Runbook
• Open an issue on GitHub

---

Last updated: 2025-12-03