Spaces:
Runtime error
Runtime error
docs: Introduce comprehensive technical documentation and update planning artifacts to reflect MVP completion and detailed FR implementation status.
d03d74d Vault - Project Documentation Index
Generated: 2026-02-11
Project: Vault
Author: VJ
Scan Type: Exhaustive Scan
Documentation Overview
This documentation was generated by BMad Master to provide comprehensive reference for AI-assisted development. The project started with BMAD planning artifacts and has evolved through multiple implementation cycles.
Available Documentation
| Document | Description |
|---|---|
| Project Overview | High-level project summary, goals, and architecture |
| Source Tree | Annotated directory structure with purpose descriptions |
| Data Models | Database schema, tables, and relationships |
| API Contracts | API routes, server actions, and endpoints |
| UI Components | Component inventory and design system |
| Inngest Workflows | Background job functions and event flows |
| Development Guide | Setup, testing, and deployment instructions |
Quick Reference
Technology Stack
| Category | Technology | Version |
|---|---|---|
| Framework | Next.js (App Router) | 15.5.12 |
| Language | TypeScript | 5.x |
| Styling | Tailwind CSS | 4.x |
| UI Components | shadcn/ui + Radix | Latest |
| Database | PostgreSQL (Supabase) | - |
| ORM | Drizzle ORM | 0.45.1 |
| Authentication | Better Auth | 1.4.18 |
| Background Jobs | Inngest | 3.49.1 |
| Caching | Upstash Redis | 1.36.1 |
| AI/Vision | Google Gemini, HuggingFace | - |
| Marketplace APIs | Amazon PA-API, eBay, Etsy | - |
| Monitoring | Sentry | 10.38.0 |
Project Structure
vault/
βββ src/
β βββ app/ # Next.js 15 App Router pages and API routes
β βββ components/ # Shared UI components (shadcn/ui)
β βββ features/ # Feature-based modules
β βββ inngest/ # Background job functions
β βββ lib/ # Core utilities (auth, db, redis)
β βββ config/ # Configuration files
βββ drizzle/ # Database migrations
βββ public/ # Static assets
βββ _bmad-output/ # BMAD planning artifacts
Key Features
- AI Object Detection - Automated product detection from video frames
- Marketplace Matching - Multi-platform affiliate link generation (Amazon, eBay, Etsy)
- Creator Dashboard - Moderation queue, analytics, revenue tracking
- Public Vault Grid - Mobile-first, SEO-optimized product discovery
- Interest Capture - "I want this" waitlist for out-of-stock items
- Admin Operations - High-ambiguity moderation, platform oversight
Original BMAD Planning Artifacts
The following planning documents were created during the initial BMAD workflow and remain in _bmad-output/planning-artifacts/:
prd.md- Product Requirements Documentarchitecture.md- Architecture Decision Documentepics.md- Epic and Story Breakdownproduct-brief-Vault-2026-02-01.md- Product Brief
Implementation Status
Implementation artifacts are tracked in _bmad-output/implementation-artifacts/:
- Sprint status:
sprint-status.yaml - Story files: Individual story markdown files
This documentation is maintained for AI-assisted development. For the most current implementation details, refer to the source code.