From 2f58ff0fbc400b2d6020be9c2f861baadfa6855c Mon Sep 17 00:00:00 2001 From: Waleed Latif Date: Mon, 3 Mar 2025 13:14:04 -0800 Subject: [PATCH] feat: Update README.md and CONTRIBUTING.md --- .env.example | 6 +----- CONTRIBUTING.md | 2 +- README.md | 7 +------ 3 files changed, 3 insertions(+), 12 deletions(-) diff --git a/.env.example b/.env.example index 7b8f07b393..4eded834a1 100644 --- a/.env.example +++ b/.env.example @@ -5,12 +5,8 @@ DATABASE_URL="postgresql://postgres:password@localhost:5432/postgres" BETTER_AUTH_SECRET=your_secret_key # Use `openssl rand -hex 32` to generate BETTER_AUTH_URL=http://localhost:3000 -# Email Provider (Required) +# Email Provider (Optional) RESEND_API_KEY=your_resend_api_key # Get from https://resend.com -# GitHub OAuth (Optional) -GITHUB_CLIENT_ID=your_github_client_id -GITHUB_CLIENT_SECRET=your_github_client_secret - # App URL (Required) NEXT_PUBLIC_APP_URL=http://localhost:3000 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1a629aaa36..16dbe16025 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -187,7 +187,7 @@ If you prefer not to use Docker: 3. **Set Up Environment:** - Copy `.env.example` to `.env` - - Configure database connection and other required variables + - Configure database connection and other required authentication variables 4. **Set Up Database:** diff --git a/README.md b/README.md index 76f0467a31..be1ef81b30 100644 --- a/README.md +++ b/README.md @@ -37,12 +37,7 @@ This will start Sim Studio at http://localhost:3000 with a local PostgreSQL data 3. **[Optional] Configure Your Environment** -Copy `.env.example` to `.env` and configure: - -- Authentication secrets (required for login functionality) -- API keys: - - **Essential**: Resend API key (for authentication emails) - - **Optional**: OpenAI, Anthropic, etc. (for specific block functionality) +In `.env`, configure Authentication secrets (required for login functionality) and optionally a Resend API key (for authentication emails). ## Manual Setup