Skip to main content

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

1

Clone the template

# Use as a GitHub template
gh repo create my-saas-app --template kloudowl/saas-kit --clone
cd my-saas-app
2

Install dependencies

pnpm install
3

Set up Supabase

Create a new project at supabase.com, then:
# 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
4

Run database migrations

npx supabase link --project-ref your-project-ref
pnpm run db:push
5

Start the dev server

pnpm run dev
Open http://localhost:3000 — you should see the login page.
6

Create a super admin

After registering your first user, promote them to super admin:
UPDATE public.profiles
SET is_super_admin = true
WHERE email = 'your@email.com';

​
Configuration

All customization goes through saas.config.ts: 
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
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.

​
What’s Next

Authentication

Understand the auth flow and session management

Workspaces

Learn about multi-tenant workspace setup

Billing

Set up Stripe for payments

Configuration

Customize the template for your needs