ryan/turbovault-app
1
0
Fork 0
mirror of https://github.com/ryankazokas/turbovault-app.git synced 2026-04-16 22:12:53 +00:00
Code Issues Packages Projects Releases Wiki Activity

Removes verbose docs

Browse Source
This commit is contained in:
Ryan Kazokas
2026-03-28 19:30:27 -04:00
parent 036fa7ab33
commit 63276ef8ca
14 changed files with 51 additions and 3296 deletions
Download Patch File Download Diff File Expand all files Collapse all files

44
README.md
View File

@@ -80,34 +80,33 @@ A demo account is automatically created in development:
TurboVault includes Docker and Kubernetes manifests for easy deployment.
### 📋 New to Deployment?
**Start here:** [DEPLOYMENT_CHECKLIST.md](docs/DEPLOYMENT_CHECKLIST.md) - Complete step-by-step deployment guide
### Kubernetes (Recommended for Production)
TurboVault is designed for Kubernetes with GitHub Actions CI/CD:
TurboVault is designed for Kubernetes with automated GitHub Actions CI/CD.
**Documentation:**
1. **📋 Deployment Checklist:** [DEPLOYMENT_CHECKLIST.md](docs/DEPLOYMENT_CHECKLIST.md) - Step-by-step guide
2. **🤖 GitHub Actions:** [GITHUB_ACTIONS_SETUP.md](docs/GITHUB_ACTIONS_SETUP.md) - Automated builds
3. **☸️ Kubernetes Guide:** [k8s README](k8s/README.md) - Full k8s documentation
**📖 Documentation:**
- ⭐ [Quick Start Guide](docs/QUICK_START.md) - Deploy in minutes
- [Deployment Guide](docs/DEPLOYMENT.md) - Complete reference
- [Kubernetes README](k8s/README.md) - K8s details
**Quick Deploy:**
**🚀 Quick Deploy:**
```bash
# 1. Push to GitHub
./scripts/setup-github.sh
git push origin main
# 2. Build image (automatic on tag push)
# 2. Tag a release (triggers automatic build)
git tag v1.0.0 && git push origin v1.0.0
# 3. Update k8s manifests with your image
# Edit k8s/deployment.yaml: image: ghcr.io/your-username/turbovault:v1.0.0
# 3. Configure Kubernetes secrets & manifests
cp k8s/secrets.yaml.example k8s/secrets.yaml
# Edit secrets.yaml, deployment.yaml, configmap.yaml
# 4. Deploy to Kubernetes
# 4. Deploy
./scripts/deploy-k8s.sh
```
See [Quick Start Guide](docs/QUICK_START.md) for detailed steps.
### Docker Compose (Development/Testing)
```bash
@@ -135,14 +134,13 @@ IGDB sync is enabled by default for all users and runs every 30 minutes.
**All documentation is in the [`docs/`](docs/) folder.**
**Quick Links:**
- 📋 [Deployment Checklist](docs/DEPLOYMENT_CHECKLIST.md) - Step-by-step deployment
- 🤖 [GitHub Actions Setup](docs/GITHUB_ACTIONS_SETUP.md) - CI/CD pipeline
- 🚀 [Deployment Guide](docs/DEPLOYMENT.md) - Complete deployment reference
- 💻 [Development Guide](docs/DEVELOPMENT_GUIDE.md) - Local development setup
- 📖 [API Documentation](docs/API_DOCUMENTATION.md) - RESTful API reference
- 🎮 [IGDB Integration](docs/IGDB_INTEGRATION.md) - Game metadata matching
- 🎨 [Themes](docs/THEMES.md) - Theme customization
- 🎯 [Demo Account](docs/DEMO_ACCOUNT.md) - Try the demo
- ⭐ [Quick Start](docs/QUICK_START.md) - Deploy in minutes
- 🚀 [Deployment Guide](docs/DEPLOYMENT.md) - Complete reference
- 💻 [Development Guide](docs/DEVELOPMENT_GUIDE.md) - Local development
- 📖 [API Documentation](docs/API_DOCUMENTATION.md) - RESTful API
- 🎮 [IGDB Integration](docs/IGDB_INTEGRATION.md) - Game metadata
- 🎨 [Themes](docs/THEMES.md) - Customization
- 🎯 [Demo Account](docs/DEMO_ACCOUNT.md) - Try it out
[**See all documentation →**](docs/README.md)