docs(configuration): document env variables and add .env.example#90
Merged
mikewheeleer merged 1 commit intoJun 24, 2026
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
9778781 to
55611df
Compare
Contributor
|
good, documenting the env vars closes a real gap. lgtm |
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.
Summary
Documents the project's environment configuration. Docs-only — no code changes.
README.mdwith a variable | purpose | default | example table covering the only two variables the code reads:PORT(read insrc/index.tsandsrc/server.ts, default3001).NODE_ENV(itstestvalue disables the rate limiter and per-request logging).No other variables are invented.
.env.exampleas the template, with an explanatory comment per line and safe placeholder defaults..env.exampleis the template and.envis git-ignored (confirmed against.gitignore), and cross-links the section from the existing "Setup (contributors)" steps.npx tsc --noEmitpasses (no code change).Rendered table
PORT30018080NODE_ENVtestdisables the rate limiter and per-request logging.productionCloses #85
Security notes
.env.exampleships only non-secret placeholder defaults and the docs reinforce that the real.envis git-ignored, keeping secrets out of version control.