Setup Guide

Get VibeReady running locally in 5 minutes. This guide walks through prerequisites, installation, configuration, and verifying that everything works.

---

Prerequisites

Before running setup, ensure you have the following installed:

Tool	Version	Installation
Node.js	18+	nodejs.org
Docker	Latest	docker.com
GitHub CLI	Latest	cli.github.com

Optional for deployment: gcloud CLI

---

Installation

Clone the repository and run the setup command:

git clone https://github.com/VibeReady/vibeready.git your-project
cd your-project
make setup

The setup wizard is an interactive CLI that walks you through configuring each service. It handles environment variables, database initialization, and third-party service connections. Depending on how many integrations you configure, setup takes 5-25 minutes.

---

Configure the AI Framework

After the core setup completes, configure the AI development framework:

make ai-setup

This one-minute step sets up git hooks for auto-documentation, AI context files, and the PRD workflow. It works with Claude Code, Cursor, Windsurf, Gemini CLI, and other AI coding tools.

For a full overview of the AI framework, see AI Framework.

---

Start the Development Server

make dev

Visit http://localhost:3000 to see the application running.

---

What’s Running

After setup, the following services are configured and active:

• PostgreSQL — Running on port 5432 via Docker, with Prisma migrations applied
• Prisma ORM — Database access layer, schema ready for development
• Environment variables — Local configuration file populated with Clerk, LLM, and Resend keys
• Inngest — Background jobs system, works without external keys in local development

Additional Development Tools

# Start Inngest Dev Server (optional, for background jobs)
make inngest-dev
# Inngest UI available at http://localhost:8288

# Open database GUI
make db-studio
# Prisma Studio available at http://localhost:5555

Useful Commands

# Run all tests
make test

# Run linter
make lint

# TypeScript type checking
make typecheck

# Reset database (development only)
make db-reset

# Generate/update feature documentation
make generate-docs

---

Deployment (Optional)

If you are ready to deploy beyond local development, VibeReady includes Terraform-managed infrastructure for Google Cloud Platform:

make setup-deployment

Deployment is automatic via GitHub Actions. Push to main and it auto-deploys to Cloud Run with scale-to-zero cost optimization. For detailed deployment instructions, see the deployment documentation.

---

Next Steps

1. Build Your First Feature — Learn the AI-driven development workflow with a hands-on tutorial
2. AI Framework — Understand AGENTS.md, scoped rules, and agent skills
3. Design Customization — Customize brand colors and fonts
4. AI Prompt Library — Browse all skills, prompts, and recovery strategies