From d1f4c5a7103da2dd1c41f01d3ec0aaed08f82a4b Mon Sep 17 00:00:00 2001 From: Ahmad Girach Date: Thu, 27 Nov 2025 23:00:17 +0530 Subject: [PATCH] [IMP] added env variable details in readme file --- README.md | 35 +++++++++++++++++++++++++++-------- 1 file changed, 27 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 2fcf05b..641279f 100644 --- a/README.md +++ b/README.md @@ -50,16 +50,35 @@ pnpm install Set up environment variables: ```bash -cp .env.example .env.local +# ----------------------------------------------------------------------------- +# Core app URLs & Better Auth configuration +# ----------------------------------------------------------------------------- +NEXT_PUBLIC_APP_URL="http://localhost:3000" +BETTER_AUTH_URL="http://localhost:3000/api/auth" +# Generate a secure random string: `openssl rand -hex 32` +BETTER_AUTH_SECRET="replace-with-generated-secret" + +# ----------------------------------------------------------------------------- +# Database (PostgreSQL / Prisma) +# ----------------------------------------------------------------------------- +# Example local connection string – update credentials/host/db as needed. +DATABASE_URL="postgresql://postgres:postgres@localhost:5432/hagenkit" + +# ----------------------------------------------------------------------------- +# OAuth providers +# ----------------------------------------------------------------------------- +GOOGLE_CLIENT_ID="your-google-oauth-client-id" +GOOGLE_CLIENT_SECRET="your-google-oauth-client-secret" + +# ----------------------------------------------------------------------------- +# Email & notifications (Resend + branding overrides) +# ----------------------------------------------------------------------------- +RESEND_API_KEY="re_your_resend_api_key" +EMAIL_FROM="noreply@hagenkit.dev" +EMAIL_FROM_NAME="HagenKit" +SUPPORT_EMAIL="support@hagenkit.dev" ``` -Update `.env.local` with your credentials: - -- `DATABASE_URL` for PostgreSQL (direct connection). -- `BETTER_AUTH_SECRET`, `BETTER_AUTH_URL`, `NEXT_PUBLIC_APP_URL`. -- OAuth providers such as `GOOGLE_CLIENT_ID` and `GOOGLE_CLIENT_SECRET`. -- Optional integrations (`RESEND_API_KEY`, Stripe keys, etc.). - Generate the Prisma client and sync the schema: ```bash