To run Directory Surf, create a .env file from the example:
cp .env.example .envThen, fill in the required values as described below:
APP_NAME– Name of your app (displayed in UI/logs). You choose this.APP_PORT– Port your app runs on locally (e.g.,3000). Common default: 3000.APP_DOMAIN– Your app’s full domain (e.g.,https://myapp.com). Used in auth/cookies/emails.ADMIN_EMAIL– Email of the app admin; used for contact or admin access.
DATABASE_URL– Full PostgreSQL connection string (e.g.,postgres://user:pass@host:port/db). 🔍 Find this in your PostgreSQL provider or your local DB setup.
-
STRIPE_SECRET_KEY– Your Stripe API secret key for backend operations. 🔍 Get it from Stripe Dashboard > Developers > API Keys. -
STRIPE_WEBHOOK_SECRET– Secret for verifying Stripe webhooks. 🔍 Found in Stripe Dashboard > Developers > Webhooks after setting up a webhook endpoint.
-
CLOUDFLARE_R2_ACCESS_KEY/SECRET_KEY– API credentials for accessing R2 storage. 🔍 Found in Cloudflare Dashboard > R2 > API Tokens. -
CLOUDFLARE_R2_BUCKET_NAME– Name of your R2 bucket. 🔍 Set when creating the bucket in Cloudflare R2. -
CLOUDFLARE_R2_ENDPOINT– Public endpoint for your R2 bucket. 🔍 Provided by Cloudflare when setting up R2.
RESEND_API_KEY– API key for sending emails with Resend. 🔍 Get it from your Resend dashboard.
-
TURNSTILE_SITE_KEY– Public key for embedding Turnstile CAPTCHA. 🔍 Available from Cloudflare Turnstile Dashboard. -
TURNSTILE_SECRET_KEY– Secret for backend CAPTCHA verification. 🔍 Also found in Turnstile settings.
GITHUB_CLIENT_ID/CLIENT_SECRET– Credentials for GitHub OAuth login. 🔍 Create at GitHub Developer Settings > OAuth Apps.
GOOGLE_CLIENT_ID/CLIENT_SECRET– Credentials for Google OAuth login. 🔍 Create at Google Cloud Console > Credentials.