Requirements

What you need before installing DirectoryKit.

System requirements

  • Node.js 18.17 or later
  • pnpm 10.4 or later (recommended package manager)
  • Git for version control

Required accounts

You'll need accounts with the following services:

Supabase (required)

Supabase provides the database (PostgreSQL), authentication, and file storage.

  1. Create a free account at supabase.com
  2. Create a new project
  3. Note your Project URL, Anon Key, and Service Role Key from Settings → API

Service Role Key

The service role key bypasses Row Level Security. Never expose it in client-side code. It's used only on the server.

Stripe (required for payments)

Stripe handles all payment processing.

  1. Create a Stripe account at stripe.com
  2. Get your Publishable Key and Secret Key from the Dashboard
  3. Set up a webhook endpoint pointing to your-domain.com/api/webhooks/stripe
  4. Create price IDs for your plans in the Stripe Dashboard

Resend (required for email)

Resend is used for transactional emails (welcome emails, notifications, etc.)

  1. Sign up at resend.com
  2. Verify your domain
  3. Get your API Key

S3-compatible storage (required for uploads)

File uploads (logos, screenshots) use an S3-compatible storage provider. You can use:

  • AWS S3
  • Cloudflare R2
  • DigitalOcean Spaces
  • MinIO (self-hosted)

You'll need: Endpoint, Region, Bucket Name, Access Key ID, Secret Access Key.

Optional services

ServicePurposeRequired?
Google AnalyticsWebsite analyticsNo
PostHogProduct analyticsNo
SEObotBlog contentNo
DiscordWebhook notificationsNo
Logo.devAutomatic logo fetchingNo
AI Provider (OpenAI/Anthropic)AI-powered featuresNo

Next steps

Everything ready? Let's install DirectoryKit.