-
Notifications
You must be signed in to change notification settings - Fork 2.6k
docs: add environment variables configuration guide #1079
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
- Add step-by-step .env setup instructions - Include security keys generation commands - Add GitHub and Google OAuth setup guides - Provide multiple AI model API key options (OpenAI, Anthropic, Ollama) - Improve contributor onboarding experience
|
@melihaltin is attempting to deploy a commit to the Sim Team on Vercel. A member of the Team first needs to authorize it. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Greptile Summary
This PR adds a comprehensive environment variables configuration section to the CONTRIBUTING.md file to help new contributors set up their development environment. The new documentation section provides step-by-step instructions for copying the .env.example file, generating security keys using OpenSSL, and configuring essential environment variables including database connections, authentication settings, and API keys for various services.
The addition fills a significant gap in the contributor onboarding process by providing clear guidance on environment setup, which previously required contributors to piece together information from multiple sources. The documentation follows a logical structure, progressing from required core variables to optional AI model APIs and OAuth integrations for GitHub and Google services. This change integrates well with the existing CONTRIBUTING.md structure and complements the existing .env.example template by providing actionable setup instructions.
PR Description Notes:
- Contains Turkish comments in the issue reference section
- References a non-specific issue number placeholder
Confidence score: 2/5
- This PR contains several critical inaccuracies that could mislead new contributors and cause setup failures
- Score reflects significant discrepancies between documented variables and actual
.env.examplerequirements, plus incorrect file path instructions - Pay close attention to the environment variables configuration section for accuracy verification against the actual codebase
1 file reviewed, 1 comment
Updated the path for copying the environment example file to reflect the correct directory structure.
| 1. **Create your environment file:** | ||
| ```bash | ||
| # Navigate to the sim directory | ||
| cp apps/sim/.env.example apps/sim/.env |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I noticed in the latest version the .env.example file seems to be in the wrong place?
user@clanker-hive:~/sim$ ls -la apps/sim/app/
total 144
drwxrwxr-x 16 user user 4096 Nov 18 01:43 .
drwxrwxr-x 23 user user 4096 Nov 18 01:57 ..
drwxrwxr-x 39 user user 4096 Nov 17 23:55 api
drwxrwxr-x 8 user user 4096 Nov 17 23:55 '(auth)'
drwxrwxr-x 3 user user 4096 Nov 17 23:55 changelog
drwxrwxr-x 2 user user 4096 Nov 17 23:55 changelog.xml
drwxrwxr-x 5 user user 4096 Nov 17 23:55 chat
-rw-rw-r-- 1 user user 1042 Nov 17 23:55 .env.example
-rw-rw-r-- 1 user user 15086 Nov 17 23:55 favicon.ico
drwxrwxr-x 6 user user 4096 Nov 17 23:55 fonts
-rw-rw-r-- 1 user user 523 Nov 17 23:55 global-error.tsx
-rw-rw-r-- 1 user user 17856 Nov 17 23:55 globals.css
-rw-rw-r-- 1 user user 1233 Nov 17 23:55 hydration-error-handler.tsx
drwxrwxr-x 4 user user 4096 Nov 17 23:55 invite
drwxrwxr-x 8 user user 4096 Nov 17 23:55 '(landing)'
-rw-rw-r-- 1 user user 8109 Nov 17 23:55 layout.tsx
drwxrwxr-x 2 user user 4096 Nov 17 23:55 llms.txt
-rw-rw-r-- 1 user user 1359 Nov 17 23:55 manifest.ts
-rw-rw-r-- 1 user user 3367 Nov 17 23:55 not-found.tsx
-rw-rw-r-- 1 user user 2930 Nov 17 23:55 page.tsx
drwxrwxr-x 2 user user 4096 Nov 17 23:55 providers
drwxrwxr-x 3 user user 4096 Nov 17 23:55 resume
-rw-rw-r-- 1 user user 1190 Nov 17 23:55 sitemap.ts
drwxrwxr-x 4 user user 4096 Nov 17 23:55 templates
-rw-rw-r-- 1 user user 1322 Nov 17 23:55 theme-provider.tsx
drwxrwxr-x 2 user user 4096 Nov 17 23:55 unsubscribe
drwxrwxr-x 3 user user 4096 Nov 17 23:55 workspace
-rw-rw-r-- 1 user user 881 Nov 17 23:55 zoom-prevention.tsxHowever, it seems to still need to be in apps/sim/. Should this file be moved?
Summary
Added a comprehensive environment variables configuration section to CONTRIBUTING.md to help new contributors set up their development environment more easily. This includes step-by-step instructions for generating security keys, configuring AI model APIs, and setting up OAuth integrations for GitHub and Google services.
Fixes #(issue)
Type of Change
Testing
✅ Tested on macOS:
.env.exampleReviewers should focus on:
Checklist
Screenshots/Videos
Before: Contributors had no clear guidance on environment setup
After: Clear step-by-step environment configuration guide with: