-
Notifications
You must be signed in to change notification settings - Fork 0
docs: add comprehensive environment variable setup guide #18
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
c99d275
📚 docs: Add comprehensive environment variable setup guide
cubxxw 4c52881
fix: resolve TypeScript error in App.tsx
cubxxw 14b693a
fix: resolve all ESLint errors in test files
cubxxw 534cca7
fix: resolve final linting warnings and CI issues
cubxxw 3bdc92e
fix: add eslint disable for Node access in tests
cubxxw 1785ed8
fix(ci): resolve security audit failure for nth-check vulnerability
cubxxw File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| # Environment Variable Setup Guide | ||
|
|
||
| ## Required Environment Variables | ||
|
|
||
| ### Core Configuration | ||
| - `REACT_APP_OPENROUTER_API_KEY`: Your OpenRouter API key (required) | ||
| - Get from: https://openrouter.ai/keys | ||
| - Format: `sk-or-v1-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx` | ||
|
|
||
| ### Optional Configuration | ||
| - `REACT_APP_APP_NAME`: Application name (default: "Prompt Tester") | ||
| - `REACT_APP_APP_VERSION`: Application version (default: "1.0.0") | ||
| - `REACT_APP_API_BASE_URL`: API base URL (default: https://openrouter.ai/api/v1) | ||
|
|
||
| ## Setup Steps | ||
|
|
||
| 1. Copy `.env.example` to `.env`: | ||
| ```bash | ||
| cp .env.example .env | ||
| ``` | ||
|
|
||
| 2. Edit `.env` and replace `your_openrouter_api_key_here` with your actual API key | ||
|
|
||
| 3. Never commit `.env` to version control (already configured in `.gitignore`) | ||
|
|
||
| ## Security Notes | ||
|
|
||
| - `.env` files are automatically ignored by git | ||
| - Never share your API key publicly | ||
| - Use environment-specific keys for different deployments |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
Using console.log in production code is not recommended. Consider using a proper logging library or removing this debug statement for production builds.