Skip to content

docs(configuration): document env variables and add .env.example#90

Merged
mikewheeleer merged 1 commit into
StableRoute-Org:mainfrom
Jagadeeshftw:docs/configuration-37-env-reference
Jun 24, 2026
Merged

docs(configuration): document env variables and add .env.example#90
mikewheeleer merged 1 commit into
StableRoute-Org:mainfrom
Jagadeeshftw:docs/configuration-37-env-reference

Conversation

@Jagadeeshftw

Copy link
Copy Markdown
Contributor

Summary

Documents the project's environment configuration. Docs-only — no code changes.

  • Adds a Configuration section to README.md with a variable | purpose | default | example table covering the only two variables the code reads:
    • PORT (read in src/index.ts and src/server.ts, default 3001).
    • NODE_ENV (its test value disables the rate limiter and per-request logging).
      No other variables are invented.
  • Adds .env.example as the template, with an explanatory comment per line and safe placeholder defaults.
  • Notes that .env.example is the template and .env is git-ignored (confirmed against .gitignore), and cross-links the section from the existing "Setup (contributors)" steps.

npx tsc --noEmit passes (no code change).

Rendered table

Variable Purpose Default Example
PORT TCP port the HTTP server binds to. 3001 8080
NODE_ENV Runtime mode; test disables the rate limiter and per-request logging. (unset) production

Closes #85

Security notes

.env.example ships only non-secret placeholder defaults and the docs reinforce that the real .env is git-ignored, keeping secrets out of version control.

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@Jagadeeshftw Jagadeeshftw force-pushed the docs/configuration-37-env-reference branch from 9778781 to 55611df Compare June 24, 2026 02:31
@mikewheeleer

Copy link
Copy Markdown
Contributor

good, documenting the env vars closes a real gap. lgtm

@mikewheeleer mikewheeleer merged commit c7e21fa into StableRoute-Org:main Jun 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document all environment variables and add an .env.example

2 participants