Skip to content

README.md

Latest commit

 

History

History
128 lines (86 loc) · 4.96 KB

README.md

File metadata and controls

128 lines (86 loc) · 4.96 KB

📚 Plated Documentation

Welcome to the Plated documentation! This folder contains all technical documentation, guides, and plans for the project.

📁 Documentation Structure

📦 setup/

Getting started and installation guides

🧪 testing/

Local testing and development guides

🔧 technical/

Technical deep dives and architecture

🚀 deployment/

Deployment rules and production guidelines

📋 plans/

Project plans and roadmaps

🗃️ database/

Database schemas and migrations

🚀 Quick Navigation

I want to...

...set up the project for the first time → Read setup/QUICK_START_GUIDE.md

...test the application locally → Read testing/README_LOCAL_TESTING.md

...understand how authentication works → Read technical/MOCK_AUTH_FLOW.md

...deploy to production → Read deployment/DEPLOYMENT_CRITICAL_RULES.md

...see what's been implemented → Read plans/2025-01-24-production-ready-plated.md

📖 Recommended Reading Order

For New Developers:

  1. setup/QUICK_START_GUIDE.md - Set up your environment
  2. testing/README_LOCAL_TESTING.md - Learn to test locally
  3. plans/2025-01-24-production-ready-plated.md - Understand the roadmap

For Deploying to Production:

  1. deployment/DEPLOYMENT_CRITICAL_RULES.md - Deployment rules
  2. Root DEPLOYMENT_RULES_QUICKREF.md - Quick checklist

For Understanding Architecture:

  1. technical/MOCK_AUTH_FLOW.md - Authentication system
  2. database/supabase_schema.sql - Database structure
  3. plans/2025-01-24-production-ready-plated.md - Full system design

🔍 Document Summaries

Setup Documentation

Document Description When to Use
QUICK_START_GUIDE.md Complete installation and setup guide with prerequisites, dependencies, and troubleshooting First time setting up the project

Testing Documentation

Document Description When to Use
README_LOCAL_TESTING.md Main testing guide with quick start, common issues, and feature verification Primary testing reference ⭐

Technical Documentation

Document Description When to Use
MOCK_AUTH_FLOW.md Complete technical explanation of the mock authentication system with diagrams and code examples Understanding or debugging authentication

Deployment Documentation

Document Description When to Use
DEPLOYMENT_CRITICAL_RULES.md Mandatory rules and checklists for production deployment Before every deployment

Planning Documentation

Document Description When to Use
2025-01-24-production-ready-plated.md Complete implementation plan with task breakdowns, progress tracking, and batch system Understanding project scope and progress

💡 Tips

  • All paths are relative - Click links to navigate directly to documents
  • Start with README files - They provide the best overview
  • Use Quick Start guides - For rapid setup without details
  • Refer to Technical docs - When debugging or understanding internals
  • Check Plans - To see what's completed and what's next

🆘 Need Help?

  1. Can't find what you're looking for? Check the Quick Navigation section above
  2. Setting up for first time? Start with setup/QUICK_START_GUIDE.md
  3. Testing not working? See testing/README_LOCAL_TESTING.md
  4. Deploying to production? Read deployment/DEPLOYMENT_CRITICAL_RULES.md

Last Updated: December 1, 2025
Maintained by: Plated Development Team