turbovault-app/docs/README.md

TurboVault Documentation

Complete documentation for TurboVault - Video Game Collection Tracker

📖 Quick Links

Getting Started

• Main README - Project overview
• ⭐ Quick Start Guide - Deploy in minutes!
• Development Guide - Local development setup
• Demo Account - Try the demo

Deployment

• Deployment Checklist - Complete deployment steps
• GitHub Actions Setup - CI/CD pipeline
• Deployment Guide - Full deployment reference

Kubernetes

• Kubernetes README - K8s deployment guide
• Container Registry Setup - Registry options

GitHub Configuration

• GitHub Secrets Setup - Optional registry configuration
• What to Commit - Safe for open source

Features

• API Documentation - RESTful API reference
• IGDB Integration - Game metadata matching
• Themes - Theme customization

Reference

• Project Summary - Feature overview
• Requirements - Original requirements
• Implementation Complete - Development progress
• Email Setup - Email configuration
• Testing Emails - Email testing guide

---

📂 Documentation Structure

turbovault-web/
├── README.md                    # Main project README
├── LICENSE                      # MIT License
│
├── docs/                        # All documentation (you are here!)
│   ├── README.md               # This file
│   ├── DEPLOYMENT_CHECKLIST.md # Step-by-step deployment
│   ├── GITHUB_ACTIONS_SETUP.md # CI/CD setup
│   ├── DEPLOYMENT.md           # Complete deployment guide
│   ├── DEVELOPMENT_GUIDE.md    # Local development
│   ├── API_DOCUMENTATION.md    # API reference
│   ├── IGDB_INTEGRATION.md     # IGDB features
│   └── ...                     # Other docs
│
├── .github/
│   ├── workflows/              # GitHub Actions
│   ├── SECRETS_SETUP.md        # GitHub Secrets guide
│   └── WHAT_TO_COMMIT.md       # Open source safety
│
└── k8s/
    ├── README.md               # Kubernetes deployment
    ├── GITEA_SETUP.md          # Gitea registry setup
    └── *.yaml                  # K8s manifests

---

🚀 Deployment Path

New to TurboVault deployment? Follow this path:

1. Read Main README
2. Follow Quick Start Guide ⭐ Start here!
3. Or use Deployment Checklist for detailed steps
4. Optional: GitHub Secrets Setup for custom registries

---

🛠️ Development Path

Want to contribute or run locally?

1. Read Main README
2. Follow Development Guide
3. Review API Documentation
4. Understand IGDB Integration

---

💡 Common Questions

Where do I start?

• Deploying: QUICK_START.md ⭐
• Developing: DEVELOPMENT_GUIDE.md

How do I set up GitHub Actions?

• No setup needed! GitHub Container Registry works automatically
• See QUICK_START.md
• For custom registries: ../.github/SECRETS_SETUP.md

What container registry should I use?

• Default: GitHub Container Registry (ghcr.io) - free, built-in
• See ../REGISTRY_SIMPLIFIED.md for other options

What's safe to commit publicly?

• ../.github/WHAT_TO_COMMIT.md

How do I use the API?

• API_DOCUMENTATION.md

What is IGDB?

• IGDB_INTEGRATION.md

---

📝 Documentation Updates

When adding new documentation:

1. Create .md file in this docs/ folder
2. Add entry to this README
3. Update cross-references in other docs
4. Use relative paths:
   • Other docs: [link](FILENAME.md)
   • Root files: [link](../FILENAME.md)
   • .github: [link](../.github/FILENAME.md)
   • k8s: [link](../k8s/FILENAME.md)

---

Need help? Check the Main README or open an issue on GitHub.