feat: Update README.md and CONTRIBUTING.md

This commit is contained in:
Waleed Latif
2025-03-03 13:14:04 -08:00
parent 619839bbb0
commit 2f58ff0fbc
3 changed files with 3 additions and 12 deletions
+1 -5
View File
@@ -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
+1 -1
View File
@@ -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:**
+1 -6
View File
@@ -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