mirror of
https://github.com/simstudioai/sim.git
synced 2026-09-24 15:45:35 +08:00
feat: Update README.md and CONTRIBUTING.md
This commit is contained in:
+1
-5
@@ -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
@@ -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:**
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user