docs: document environment configuration#118
Closed
felixvippp-ai wants to merge 1 commit into
Closed
Conversation
Contributor
|
thanks for the effort here @felixvippp-ai! 🙏 issue #54 isn't assigned to you, and we merge from the assigned contributor to keep the campaign fair. please claim an open unassigned issue first, then open your PR. closing this one for now — hope to see it back 🙌 |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #54
Summary
.env.examplecovering every environment variable currently read by the app.env.examplewhile keeping real.envand.env.*files ignoredPORT,CORS_ALLOWED_ORIGINS, andNODE_ENVDocumented variables
PORT- HTTP listen port, default3001CORS_ALLOWED_ORIGINS- comma-separated exact Origin allowlist, default emptyNODE_ENV- runtime mode;testskips rate limiting and suppresses duration logsValidation
npm.cmd run buildnpm.cmd run lint$env:NODE_ENV='test'; node --test dist/*.test.js dist/**/*.test.js- 69 tests passedgit check-ignore -v .env.exampleshows the explicit!.env.exampleunignore rulegit add --dry-run .env.exampleconfirms the example file is tracked normallyrg process.env / src README package.json .env.exampleconfirmed the documented variables match current env reads