mirror of
https://github.com/ryankazokas/turbovault-app.git
synced 2026-04-16 23:22:53 +00:00
83 lines
1.7 KiB
Markdown
83 lines
1.7 KiB
Markdown
# 🎮 TurboVault
|
|
|
|
> Your personal video game collection tracker
|
|
|
|
[](https://rubyonrails.org/)
|
|
|
|
|
|
Track your physical and digital game collection with automatic metadata from IGDB.
|
|
|
|
## Features
|
|
|
|
- 📦 Track physical & digital games
|
|
- 🎯 Collections & subcollections
|
|
- 🔍 Search, filter, sort
|
|
- 📊 Statistics dashboard
|
|
- 📥 CSV bulk import
|
|
- 🎮 IGDB metadata matching
|
|
- 🔌 RESTful API
|
|
|
|
## Quick Start
|
|
|
|
### Local Development
|
|
|
|
```bash
|
|
# Start services
|
|
task docker:up
|
|
|
|
# Setup database
|
|
task db:setup
|
|
|
|
# Run server
|
|
task dev
|
|
```
|
|
|
|
Visit http://localhost:3000
|
|
|
|
**Demo:** demo@turbovault.com / password123
|
|
|
|
### Deploy to Kubernetes
|
|
|
|
```bash
|
|
# 1. Build & push image
|
|
git tag v1.0.0 && git push origin v1.0.0
|
|
|
|
# 2. Configure secrets
|
|
cp k8s/secrets.yaml.example k8s/secrets.yaml
|
|
# Edit with your values
|
|
|
|
# 3. Deploy
|
|
./scripts/deploy-k8s.sh
|
|
```
|
|
|
|
See [docs/QUICK_START.md](docs/QUICK_START.md) for details.
|
|
|
|
## Tech Stack
|
|
|
|
- Ruby on Rails 8.1 with Sorbet types
|
|
- PostgreSQL with Row Level Security
|
|
- Hotwire (Turbo + Stimulus)
|
|
- Tailwind CSS
|
|
- Solid Queue for background jobs
|
|
|
|
## Documentation
|
|
|
|
- [Quick Start](docs/QUICK_START.md) - Getting started guide
|
|
- [Development](docs/DEVELOPMENT_GUIDE.md) - Local development
|
|
- [API Docs](docs/API_DOCUMENTATION.md) - RESTful API reference
|
|
- [Deployment](docs/DEPLOYMENT.md) - Production deployment
|
|
|
|
## Commands
|
|
|
|
```bash
|
|
task dev # Start dev server
|
|
task test # Run tests
|
|
task lint # Check code style
|
|
task lint:fix # Auto-fix style issues
|
|
task typecheck # Run type checker
|
|
```
|
|
|
|
## License
|
|
|
|
MIT - See [LICENSE](LICENSE)
|