Files
turbovault-app/docs/QUICK_START.md
2026-03-29 02:55:42 -04:00

781 B

Quick Start Guide

Get TurboVault running locally in minutes.

Local Development

Prerequisites

  • Ruby 3.3+
  • Docker (for services)

Setup

# Clone
git clone https://github.com/ryankazokas/turbovault-app.git
cd turbovault

# Start services (PostgreSQL + Mailpit)
task docker:up

# Setup database
task db:setup

# Start server
task dev

Visit http://localhost:3000

Demo Account

  • Email: demo@turbovault.com
  • Password: password123

Optional: IGDB Integration

For automatic game metadata:

  1. Create app at https://dev.twitch.tv
  2. Add to .env:
    IGDB_CLIENT_ID=your_id
    IGDB_CLIENT_SECRET=your_secret
    
  3. Restart server

Deployment

For production deployment to Kubernetes, see Deployment Guide.