mirror of
https://github.com/ryankazokas/turbovault-app.git
synced 2026-04-17 07:52:53 +00:00
46 lines
1.6 KiB
Markdown
46 lines
1.6 KiB
Markdown
# TurboVault Documentation
|
|
|
|
Complete documentation for TurboVault - Video Game Collection Tracker
|
|
|
|
## 📖 Documentation
|
|
|
|
### Getting Started
|
|
- [Main README](../README.md) - Project overview
|
|
- ⭐ [Quick Start Guide](QUICK_START.md) - **Deploy in minutes!**
|
|
- [Demo Account](DEMO_ACCOUNT.md) - Try the demo
|
|
|
|
### Deployment & Development
|
|
- [Deployment Guide](DEPLOYMENT.md) - Complete deployment reference
|
|
- [Development Guide](DEVELOPMENT_GUIDE.md) - Local development & contributing
|
|
- [CI Pipeline](CI_PIPELINE.md) - GitHub Actions & quality checks
|
|
- [Kubernetes README](../k8s/README.md) - Kubernetes deployment
|
|
|
|
### Features & Development
|
|
- [API Documentation](API_DOCUMENTATION.md) - RESTful API reference
|
|
- [IGDB Integration](IGDB_INTEGRATION.md) - Game metadata matching
|
|
- [Themes](THEMES.md) - Theme customization
|
|
- [Sorbet Type Checking](SORBET.md) - Gradual static types
|
|
|
|
### Configuration
|
|
- [GitHub Secrets Setup](../.github/SECRETS_SETUP.md) - Optional custom registry
|
|
- [What to Commit](../.github/WHAT_TO_COMMIT.md) - Safe for open source
|
|
|
|
---
|
|
|
|
## 🚀 Quick Navigation
|
|
|
|
**New to TurboVault?**
|
|
1. Read [Main README](../README.md)
|
|
2. Deploy with [Quick Start Guide](QUICK_START.md) ⭐
|
|
3. Or develop locally with [Development Guide](DEVELOPMENT_GUIDE.md)
|
|
|
|
**Looking for something specific?**
|
|
- Deploying to production → [DEPLOYMENT.md](DEPLOYMENT.md)
|
|
- Using the API → [API_DOCUMENTATION.md](API_DOCUMENTATION.md)
|
|
- Game metadata features → [IGDB_INTEGRATION.md](IGDB_INTEGRATION.md)
|
|
- Customizing themes → [THEMES.md](THEMES.md)
|
|
|
|
---
|
|
|
|
**Need help?** Check the [Main README](../README.md) or [open an issue](https://github.com/yourusername/turbovault/issues).
|