SLYMeR fka. NaturalQuoteTracker (NQT)

NOTE: Pre-rollout Version: 7.3.1 Repo Update Stalled by Stalkerware. See the 26PDRO00474 Repo for additional insight. Till then:

See SLYMeR Solving the Industry's Two Core Problems: https://www.loom.com/share/40aa6f1a5e7348429475ae3f3d09e17f

The Unabridged, Yet Stalkerware Delayed Demo: https://fathom.video/share/2WovVtCMbDvcPPW1ox6o7kKU4BZb5Hb2

Last pre-rollout Sync: https://fathom.video/share/DyHPa_tjZNin3xHMR1kVvve3PriiRzPx

Version 6.7.3 - Natural Stone Inventory Management CRM

A production-grade CRM system for natural stone inventory management, warehouse operations, sales quoting, and invoicing. Features consolidated API v1 architecture, sub-250ms boot time, and comprehensive canon enforcement.

🚀 Quick Start

# Clone and install
git clone <repository-url>
cd natural-quote-tracker
# Install dependencies with your package manager

# Environment setup
cp .env.example .env
# Configure DATABASE_URL and other variables

# Database setup
npm run db:push

# Start development
npm run dev

Application runs at http://localhost:5000

→ Full setup guide: docs/setup/getting-started.md

📚 Documentation

Comprehensive documentation is organized in the /docs directory:

🚀 Setup & Installation

• Getting Started - Installation and environment setup
• Development Guide - API testing, debugging, workflows

🔌 API Reference

• API Routes - Complete endpoint documentation with auth requirements

🗄️ Database

• Migrations - Schema updates and rollback procedures

🔗 Integrations

• Square Integration - Payment automation
• Monitoring Stack - Prometheus/Grafana setup

🧪 Testing

• Canon Framework - Compliance testing
• Test Credentials - Standardized test accounts

🏛️ Architecture

• System Overview - Design principles
• Canonical IDs - SSOT ID validation patterns

→ Complete index: docs/INDEX.md

🏗️ Key Features

• API Consolidation: Unified /api/* namespace with OpenAPI compliance
• Sub-250ms Boot: Optimized startup with structured logging
• Hierarchical IDs: Deterministic slab/bundle tracking (no UUIDs)
• Warehouse Canon: SSOT principles with append-only movements
• CST Timezone: Consistent America/Chicago business time
• Canon Enforcement: Automated compliance testing framework

🧪 Test Credentials

Test environments only (NODE_ENV=test):

Username	Password	Roles
admin	password	admin, ops, sales

See docs/testing/credentials.md for details.

🛠️ Development

# Run tests
npm test

# Type checking
npm run check

# Database operations
npm run db:push
npm run db:studio

# Quality pipeline
./scripts/ci-local.sh

See docs/setup/development.md for full development guide.

📊 Quality Standards

Gate	Threshold	Status
TypeScript	0 errors	🔴 Blocks commit
ESLint	0 warnings	🔴 Blocks commit
Build	<60s	🔴 Blocks commit
Bundle Size	JS: 500KB, CSS: 100KB	🔴 Blocks commit
Test Coverage	80% lines/branches	🔴 Blocks commit

🚀 API Surface

All routes under /api/*:

• Authentication: Login, logout, user info
• Users: CRUD with role filtering
• Suppliers: Management and document intake
• Clients: Customer management
• Warehouse: Den statistics, slab assignments
• Inventory: Slabs, bundles, movements

→ Full API reference: docs/api/routes.md

📋 Canon & Guardrails

NQT enforces strict data integrity rules:

• ❌ No UUIDs in core warehouse systems
• ✅ Hierarchical IDs: order → material_order → bundle → slab
• ✅ SSOT Append-Only: warehouse.movements_v2 is immutable
• ✅ Canonical Validators: Regex patterns in shared/validators/
• ✅ m² Canonical: Square meters for storage, ft² derived via 10.7639
• ✅ CST Timezone: America/Chicago for all business timestamps

See docs/architecture/canonical-ids.md and canon_and_guardrails.md for details.

🔍 Project Structure

natural-quote-tracker/
├── client/          # React frontend
├── server/          # Express backend
├── shared/          # Shared types & validators (SSOT)
├── db/              # Database migrations
├── docs/            # 📚 Comprehensive documentation
├── tests/           # Test suites (canon, unit, e2e)
├── infra/           # Monitoring infrastructure
└── scripts/         # Maintenance & quality scripts

📖 Additional Documentation

• replit.md - Agent guidelines and system preferences
• canon_and_guardrails.md - Compliance rules
• docs/INDEX.md - Complete documentation index

🤝 Contributing

1. Review docs/architecture/overview.md
2. Check docs/architecture/canonical-ids.md for ID patterns
3. Run quality pipeline before commits: ./scripts/ci-local.sh
4. Ensure zero TypeScript/ESLint errors

---

Version: 6.7.3
Documentation: docs/INDEX.md
Last Updated: October 20, 2025