mirror of
https://github.com/ryankazokas/turbovault-app.git
synced 2026-04-17 04:02:53 +00:00
134 lines
4.4 KiB
Markdown
134 lines
4.4 KiB
Markdown
# TurboVault Documentation
|
|
|
|
Complete documentation for TurboVault - Video Game Collection Tracker
|
|
|
|
## 📖 Quick Links
|
|
|
|
### Getting Started
|
|
- [Main README](../README.md) - Project overview
|
|
- ⭐ [Quick Start Guide](QUICK_START.md) - **Deploy in minutes!**
|
|
- [Development Guide](DEVELOPMENT_GUIDE.md) - Local development setup
|
|
- [Demo Account](DEMO_ACCOUNT.md) - Try the demo
|
|
|
|
### Deployment
|
|
- [Deployment Checklist](DEPLOYMENT_CHECKLIST.md) - Complete deployment steps
|
|
- [GitHub Actions Setup](GITHUB_ACTIONS_SETUP.md) - CI/CD pipeline
|
|
- [Deployment Guide](DEPLOYMENT.md) - Full deployment reference
|
|
|
|
### Kubernetes
|
|
- [Kubernetes README](../k8s/README.md) - K8s deployment guide
|
|
- [Container Registry Setup](../REGISTRY_SIMPLIFIED.md) - Registry options
|
|
|
|
### GitHub Configuration
|
|
- [GitHub Secrets Setup](../.github/SECRETS_SETUP.md) - Optional registry configuration
|
|
- [What to Commit](../.github/WHAT_TO_COMMIT.md) - Safe for open source
|
|
|
|
### Features
|
|
- [API Documentation](API_DOCUMENTATION.md) - RESTful API reference
|
|
- [IGDB Integration](IGDB_INTEGRATION.md) - Game metadata matching
|
|
- [Themes](THEMES.md) - Theme customization
|
|
|
|
### Reference
|
|
- [Project Summary](PROJECT_SUMMARY.md) - Feature overview
|
|
- [Requirements](REQUIREMENTS.md) - Original requirements
|
|
- [Implementation Complete](IMPLEMENTATION_COMPLETE.md) - Development progress
|
|
- [Email Setup](EMAIL_SETUP_SUMMARY.md) - Email configuration
|
|
- [Testing Emails](TESTING_EMAILS.md) - 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](../README.md)
|
|
2. **Follow [Quick Start Guide](QUICK_START.md)** ⭐ Start here!
|
|
3. Or use [Deployment Checklist](DEPLOYMENT_CHECKLIST.md) for detailed steps
|
|
4. Optional: [GitHub Secrets Setup](../.github/SECRETS_SETUP.md) for custom registries
|
|
|
|
---
|
|
|
|
## 🛠️ Development Path
|
|
|
|
**Want to contribute or run locally?**
|
|
|
|
1. Read [Main README](../README.md)
|
|
2. Follow [Development Guide](DEVELOPMENT_GUIDE.md)
|
|
3. Review [API Documentation](API_DOCUMENTATION.md)
|
|
4. Understand [IGDB Integration](IGDB_INTEGRATION.md)
|
|
|
|
---
|
|
|
|
## 💡 Common Questions
|
|
|
|
**Where do I start?**
|
|
- Deploying: [QUICK_START.md](QUICK_START.md) ⭐
|
|
- Developing: [DEVELOPMENT_GUIDE.md](DEVELOPMENT_GUIDE.md)
|
|
|
|
**How do I set up GitHub Actions?**
|
|
- No setup needed! GitHub Container Registry works automatically
|
|
- See [QUICK_START.md](QUICK_START.md)
|
|
- For custom registries: [../.github/SECRETS_SETUP.md](../.github/SECRETS_SETUP.md)
|
|
|
|
**What container registry should I use?**
|
|
- Default: GitHub Container Registry (ghcr.io) - free, built-in
|
|
- See [../REGISTRY_SIMPLIFIED.md](../REGISTRY_SIMPLIFIED.md) for other options
|
|
|
|
**What's safe to commit publicly?**
|
|
- [../.github/WHAT_TO_COMMIT.md](../.github/WHAT_TO_COMMIT.md)
|
|
|
|
**How do I use the API?**
|
|
- [API_DOCUMENTATION.md](API_DOCUMENTATION.md)
|
|
|
|
**What is IGDB?**
|
|
- [IGDB_INTEGRATION.md](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](../README.md) or open an issue on GitHub.
|