Back to DocumentationGetting Started

Complete Setup Guide

Getting Started with NextReady

Follow this comprehensive guide to set up, customize, and deploy your NextReady application in under 30 minutes.

30 minutes setup time

Production ready

Zero configuration

Setup Overview

Clone & Install

2 min

Get the code and install dependencies

Environment Setup

5 min

Configure your development environment

Database Setup

8 min

Set up PostgreSQL with Neon and run migrations

Authentication

10 min

Configure OAuth providers (optional)

Local Development

2 min

Start your development server

Deploy to Production

15 min

Deploy to Vercel and go live

Choose Your Setup Method

Recommended for beginners

Our interactive CLI will guide you through each step with helpful prompts and validation.

Clone Repository & Install Dependencies

Get the NextReady codebase and install all required packages

# Clone the repository
git clone https://github.com/your-username/nextready.git
cd nextready

# Install dependencies
npm install

Run Interactive Setup

Our CLI will guide you through environment, database, and service configuration

# Run interactive setup (recommended)
npm run setup

# Or manual setup
npm run setup:env

What the interactive setup does:

• Creates and configures your .env.local file
• Sets up Neon PostgreSQL database connection
• Configures OAuth providers (optional)
• Sets up Vercel Blob storage (optional)
• Configures Resend email service (optional)
• Runs database migrations and seeding

Start Development Server

Launch your application locally and start building

# Start development server
npm run dev

# Your app is now running at http://localhost:3000

Your NextReady application is now running locally!

Deploy to Production

Deploy to Vercel (Recommended)

Deploy your NextReady application to production in minutes with Vercel's GitHub integration

# Push to GitHub
git add .
git commit -m "Ready for deployment"
git push origin main

# Deploy to Vercel (automatic via GitHub integration)

Connect to Vercel

Connect your GitHub repository to Vercel for automatic deployments

Configure Environment Variables

Add your production environment variables in Vercel dashboard

Deploy & Go Live

Every push to main branch automatically deploys to production

Full Deployment Guide

Common Issues & Solutions

Database connection failed

Check your DATABASE_URL format and ensure Neon database is running

OAuth providers not working

Verify redirect URLs match your development URL (http://localhost:3000)

Build errors during deployment

Run npm run type-check and npm run build locally first

🎉 Congratulations!

Your NextReady application is now set up and running. Ready to start building amazing features?

Customize Your App Learn Authentication