Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

76 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

PipeVault

Enterprise-grade pipe storage management portal for MPS Group's "Free Pipe Storage" promotion.

Customers submit storage requests and monitor projects. Admins approve work, assign racks, and track inventory with AI assistance.


Quick Overview

FREE, enterprise-grade application built in 2 weeks with AI assistance (traditional cost: $222,000, 9 months).

Key Innovations:

  • AI-Powered: Gemini Vision extracts manifest data automatically, Claude chatbot provides instant assistance
  • Zero Friction: One-click booking, auto-filled forms, drag-and-drop uploads, real-time status updates
  • Real-time Collaboration: Multiple admins see changes instantly (like Google Docs)
  • Production Security: Multi-tenant RLS, atomic transactions, comprehensive audit trails

Impact:

  • Customers: Book storage in 5 minutes (vs 2 days of emails)
  • Admins: Approve requests in 30 seconds with AI-verified data
  • MPS Group: $312,000 5-year value, fully customizable, zero vendor lock-in

🎯 Read Full Elevator Pitch | πŸ“Š View Statistics


Project Statistics

Enterprise application: 119,105 lines of code + documentation

Metric Count
Total Lines 119,105
TypeScript/JavaScript 30,222 lines
SQL (Database) 14,479 lines
Documentation 74,404 lines
React Components 51
Database Migrations 81
Total Files 308+

Development Comparison

Metric Traditional Agency AI-Assisted Savings
Development Time 37 weeks (~9 months) 2 weeks 94% faster
Estimated Cost $222,000 @ $150/hr $0 $222,000 saved
Documentation ~100 lines/hour ~15,000 lines/hour 15,000% faster

Key Achievement: 74,404 lines of docs vs 44,701 lines of code (1.66:1 ratio, industry average is 0.2:1)

πŸ“Š View Detailed Statistics


Technology Stack

  • Frontend: React 19.2.0 + Vite 6.2.0 + TypeScript 5.3.3
  • State Management: TanStack Query 5.20.0 + Zustand 4.5.0
  • Backend: Supabase (PostgreSQL 15 + Realtime + Storage)
  • Styling: Tailwind CSS 3.4.17
  • AI: Google Gemini 2.0/2.5 Flash + Claude (Anthropic)
  • Notifications: Resend API (email) + Slack Webhooks
  • Weather: Tomorrow.io API
  • Deployment: GitHub Pages (auto-deploy on push to main)

Cost: $27.50/month (Supabase free tier + API usage)


Quick Start

1. Clone Repository

git clone https://github.com/your-org/PipeVault.git
cd PipeVault

2. Install Dependencies

npm install

3. Configure Environment

Create .env from .env.example:

VITE_SUPABASE_URL=your_project_url
VITE_SUPABASE_ANON_KEY=your_anon_key
VITE_GOOGLE_AI_API_KEY=your_gemini_key
VITE_RESEND_API_KEY=your_resend_key
VITE_TOMORROW_API_KEY=your_tomorrow_io_key

πŸ“– Complete Setup Guide

4. Setup Database

  1. Create Supabase project at supabase.com
  2. Run migrations in SQL Editor (execute files in /supabase/migrations/ in order)
  3. Configure RLS policies

πŸ“– Database Setup Guide

5. Configure AI Services

Set up Gemini API key for manifest extraction and chatbot features.

πŸ“– AI Setup Guide

6. Setup Notifications

Configure Resend (email) and Slack webhooks for real-time notifications.

πŸ“– Notifications Setup Guide

7. Start Development Server

npm run dev

Visit http://localhost:5173


Core Workflows

Customer Journey

  1. Sign Up β†’ Email verification via Supabase Auth
  2. Create Storage Request β†’ Submit pipe specifications and delivery preferences
  3. Book Inbound Load β†’ Schedule delivery, upload manifest (AI extracts data automatically)
  4. Track Progress β†’ Real-time status updates (PENDING β†’ APPROVED β†’ IN_TRANSIT β†’ COMPLETED)
  5. View Inventory β†’ See stored pipe with rack locations

Admin Workflow

  1. Review Pending Requests β†’ View AI-generated summaries and pipe specs
  2. Approve/Reject β†’ Atomic approval with rack assignment and capacity validation
  3. Track Loads β†’ Monitor deliveries (NEW β†’ APPROVED β†’ IN_TRANSIT β†’ COMPLETED)
  4. Manage Inventory β†’ View all inventory with rack assignments and company breakdown

πŸ“– Testing Guide for step-by-step testing procedures


Documentation

πŸ“š Quick Navigation

Essential Docs:

Setup Guides:

Architecture:

Guides:

Planning & Analysis:

πŸ“– DOCUMENTATION_INDEX.md - Complete documentation navigation


Deployment

PipeVault auto-deploys to GitHub Pages on every push to main branch.

Build & Deploy

# Build for production
export VITE_GITHUB_PAGES=true
npm run build

# Deploy to GitHub Pages (automatic via GitHub Actions)
git push origin main

Database Migrations

Apply migrations via Supabase Dashboard SQL Editor or CLI:

npx supabase db push

Edge Functions

Deploy notification worker:

npx supabase functions deploy process-notification-queue

πŸ“– Complete Deployment Guide


Testing

Run Tests

# Type check
npm run type-check

# Build
npm run build

# Preview production build
npm run preview

Manual Testing

Follow the comprehensive testing guide for customer and admin workflows.

πŸ“– Testing Guide


Current Version

Version: 2.0.13 Last Updated: 2025-11-16 Status: Production-ready

Recent Changes:

  • Documentation reorganization (82% token reduction)
  • Architecture docs consolidated
  • Setup guides unified
  • Testing and deployment guides created

πŸ“– Full Changelog


Troubleshooting

Common Issues

Problem: Database connection fails Solution: Check Supabase credentials in .env and verify project is not paused

Problem: AI manifest extraction not working Solution: Verify VITE_GOOGLE_AI_API_KEY is set correctly

Problem: Email notifications not sending Solution: Verify VITE_RESEND_API_KEY and check notification queue

πŸ“– Complete Troubleshooting Guide


Support & Contact

Documentation Issues: Check DOCUMENTATION_INDEX.md or TROUBLESHOOTING.md

Technical Questions: Review architecture and setup guides

Bug Reports: Create detailed issue with:

  • Steps to reproduce
  • Expected vs actual behavior
  • Browser/device information
  • Console errors (if applicable)

Contact: support@mpsgroup.ca


Project Structure

PipeVault/
β”œβ”€β”€ src/                    # React application source
β”‚   β”œβ”€β”€ components/         # React components
β”‚   β”œβ”€β”€ hooks/              # Custom React hooks
β”‚   β”œβ”€β”€ services/           # API services (Supabase, AI, notifications)
β”‚   β”œβ”€β”€ types/              # TypeScript type definitions
β”‚   └── utils/              # Utility functions
β”œβ”€β”€ supabase/               # Database migrations and config
β”‚   └── migrations/         # SQL migration files
β”œβ”€β”€ docs/                   # Documentation
β”‚   β”œβ”€β”€ setup/              # Setup guides
β”‚   β”œβ”€β”€ architecture/       # System architecture docs
β”‚   β”œβ”€β”€ guides/             # Testing, deployment guides
β”‚   β”œβ”€β”€ planning/           # Project planning docs
β”‚   └── archive/            # Historical documentation
β”œβ”€β”€ .claude/                # Claude Code agent playbooks
β”‚   └── agents/             # Specialized agent configurations
β”œβ”€β”€ DOCUMENTATION_INDEX.md  # Master navigation
β”œβ”€β”€ TROUBLESHOOTING.md      # Quick problem-solving guide
β”œβ”€β”€ CHANGELOG.md            # Version history
└── README.md               # This file

License

Proprietary - MPS Group

Copyright Β© 2025 MPS Group. All rights reserved.


Built with ❀️ and AI assistance by MPS Group

Documentation: πŸ“– DOCUMENTATION_INDEX.md | Troubleshooting: πŸ”§ TROUBLESHOOTING.md | Changelog: πŸ“ CHANGELOG.md

About

Pipe Inventory Management Software

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages