Quick Start Guide

Get up and running with Went in less than 5 minutes. This guide will walk you through creating your first Went application and exploring its key features.

Prerequisites

Before you begin, make sure you have the following installed:

  • Node.js 18+ - Download from nodejs.org
  • npm or yarn - Comes with Node.js
  • Git - For version control
  • Database - We recommend Supabase for easy setup (or PostgreSQL locally)

Step 1: Create Your Went Application

Create a new Went application using the CLI:

# Create a new Went application
npx create-went-app@latest my-app
# Navigate to your project
cd my-app

This will create a new directory with your Went application, including all necessary dependencies and configuration files.

Step 2: Configure Environment Variables

The Went CLI has already created a .env file for you. Edit it with your database URL and authentication settings:

# Database
DATABASE_URL="postgresql://username:password@localhost:5432/myapp"

# NextAuth.js
NEXTAUTH_SECRET="your-secret-key"
NEXTAUTH_URL="http://localhost:3000"

# Optional: OAuth providers
GOOGLE_CLIENT_ID="your-google-client-id"
GOOGLE_CLIENT_SECRET="your-google-client-secret"
GITHUB_CLIENT_ID="your-github-client-id"
GITHUB_CLIENT_SECRET="your-github-client-secret"

Step 3: Set Up Your Database

Initialize your database with Prisma migrations:

# Run initial database migration
went db migrate init

Step 4: Start Development Server

Start the development server and begin building:

# Navigate to your project
cd my-app

# Start the development server
npm run dev

Your application will be running at http://localhost:3000

🎉 Congratulations!

Your Went application is now running with authentication, database, and API routes ready to use.

What's Included

Development Tools
  • • Hot reloading with Turbopack
  • • TypeScript configuration
  • • ESLint & Prettier
  • • Tailwind CSS setup
Backend Ready
  • • tRPC API routes
  • • Prisma ORM setup
  • • Database migrations
  • • Auth.js integration
Production Ready
  • • Vercel deployment config
  • • Environment variables
  • • Security best practices
  • • Performance optimizations

Next Steps

Continue your journey with Went:

Need Help?

If you run into any issues, here are some resources to help you: