quickstart.mdx

title	Quick Start
description	Get Fred running locally in minutes

Prerequisites

• Node.js 22.20.0 LTS or higher
• pnpm 10.28.0 or higher
• PostgreSQL 15+ (or a Supabase account)
• Git

Installation

```bash git clone https://github.com/Kiquix/Fred-Client.git cd Fred-Client ``` ```bash pnpm install ``` Copy the template and fill in your values:

```bash
cp .env.example .env
```

Minimum required variables:

```bash
# Database
SUPABASE_DATABASE_URL="postgresql://user:pass@host:6543/db?pgbouncer=true"
DATABASE_DIRECT_URL="postgresql://user:pass@host:5432/db"

# Auth
AUTH_SECRET="$(openssl rand -base64 32)"
AUTH_GOOGLE_ID="your-google-oauth-client-id"
AUTH_GOOGLE_SECRET="your-google-oauth-secret"

# App
APP_URL="http://localhost:3000"
NODE_ENV="development"
```

See the [Development guide](/development#environment-variables) for the full variable reference.

Generate the Prisma client and apply migrations:

```bash
pnpm prisma generate
pnpm prisma migrate dev
```

Optionally seed with sample data:

```bash
pnpm prisma db seed
```

```bash pnpm dev ```

The app is now available at [http://localhost:3000](http://localhost:3000).

What you can do next

Understand how Fred's layers fit together. Connect AWS S3, Stripe, the AI service, and email. Learn the component library and design system. Write server actions and services.

Common commands

# Development
pnpm dev                    # Start dev server (http://localhost:3000)
pnpm build                  # Production build
pnpm start                  # Start production server

# Database
pnpm prisma generate        # Regenerate Prisma client after schema changes
pnpm prisma migrate dev     # Create and apply a new migration
pnpm prisma studio          # Open Prisma Studio GUI

# Code quality
pnpm typecheck              # TypeScript type checking
pnpm lint                   # ESLint
pnpm format                 # Prettier

# Testing
pnpm test:build             # Validate production build locally
pnpm test:docker            # Validate Docker build