> ## Documentation Index
> Fetch the complete documentation index at: https://docs.auction-rise.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get your Auction Rise project running in minutes

# Quickstart

<Steps>
  <Step title="Clone the template">
    ```bash theme={null}
    # Use as a GitHub template
    gh repo create my-saas-app --template kloudowl/saas-kit --clone
    cd my-saas-app
    ```
  </Step>

  <Step title="Install dependencies">
    ```bash theme={null}
    pnpm install
    ```
  </Step>

  <Step title="Set up Supabase">
    Create a new project at [supabase.com](https://supabase.com), then:

    ```bash theme={null}
    # Copy the env example
    cp .env.local.example .env.local

    # Fill in your Supabase credentials
    # NEXT_PUBLIC_SUPABASE_URL=https://your-project.supabase.co
    # NEXT_PUBLIC_SUPABASE_ANON_KEY=your-anon-key
    # SUPABASE_SERVICE_ROLE_KEY=your-service-role-key
    ```
  </Step>

  <Step title="Run database migrations">
    ```bash theme={null}
    npx supabase link --project-ref your-project-ref
    pnpm run db:push
    ```
  </Step>

  <Step title="Start the dev server">
    ```bash theme={null}
    pnpm run dev
    ```

    Open [http://localhost:3000](http://localhost:3000) — you should see the login page.
  </Step>

  <Step title="Create a super admin">
    After registering your first user, promote them to super admin:

    ```sql theme={null}
    UPDATE public.profiles
    SET is_super_admin = true
    WHERE email = 'your@email.com';
    ```
  </Step>
</Steps>

## Configuration

All customization goes through `saas.config.ts`:

```typescript theme={null}
export const saasConfig = {
  name: "Auction Rise",
  auth: {
    protectedRoutes: ["/dashboard", "/settings", "/admin"],
    afterLoginRedirect: "/dashboard",
  },
  sidebar: {
    navItems: [
      // Add your custom nav items here
    ],
  },
};
```

## Adding Your First Feature

Consumer code goes in directories the template doesn't touch:

* **Routes**: `app/(platform)/your-feature/`
* **Logic**: `lib/your-feature/`
* **Components**: `components/your-feature/`
* **Migrations**: `supabase/migrations/20260401000000_your_table.sql`

<Tip>
  Use timestamp-based migration names (e.g., `20260401000000_`) for your domain tables. The template uses sequential names (`00001_` through `00028_`) to avoid conflicts when pulling template updates.
</Tip>

## What's Next

<CardGroup cols={2}>
  <Card title="Authentication" icon="lock" href="/docs/features/authentication">
    Understand the auth flow and session management
  </Card>

  <Card title="Workspaces" icon="building" href="/docs/features/workspaces">
    Learn about multi-tenant workspace setup
  </Card>

  <Card title="Billing" icon="credit-card" href="/docs/features/billing">
    Set up Stripe for payments
  </Card>

  <Card title="Configuration" icon="gear" href="/docs/features/configuration">
    Customize the template for your needs
  </Card>
</CardGroup>