docs: document configuration and add .env.example reference - #439
Merged
mikewheeleer merged 1 commit intoJul 26, 2026
Merged
Conversation
Contributor
|
love this — in it goes 🚀 |
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 #283
Summary of Changes
1. Added Environment Template (
.env.example)Created a
.env.exampletemplate containing all 20 environment variables currently read across the codebase, complete with section headings, inline explanatory comments, and safe default placeholders:PORT,NODE_ENV,LOG_LEVELADMIN_TOKEN,CORS_ALLOWED_ORIGINS,TRUST_PROXYALLOW_UNREGISTERED_QUOTESSTORAGE_BACKEND,STORAGE_FILE,PERSIST_PATH,PAUSE_STATE_FILEREQUEST_TIMEOUT_MS,KEEP_ALIVE_TIMEOUT_MS,HEADERS_TIMEOUT_MS,IDEMPOTENCY_TTL_MS,IDEMPOTENCY_CACHE_MAXSHUTDOWN_GRACE_MS,FLUSH_TIMEOUT_MSGIT_COMMIT,BUILD_TIME2. Comprehensive Configuration Reference in
README.md3. Copy the environment configuration template: cp .env.example .envunder Setup (contributors) and cross-linked it to the Configuration section..envis git-ignored (per .gitignore) and emphasized that.env.exampleis the template and.envshould never be committed with real secrets.3. Automated Validation Unit Test (
src/__tests__/envExample.test.ts)Added a test suite that:
.env.exampleexists at root..env.exampleparses into valid key-value pairs without syntax errors and contains all expected environment variables..env.exampleis documented inREADME.md.Rendered Configuration Section (for PR Description)
Note that Node.js / Express does not automatically auto-load
.envat runtime unless variables are exported into your shell, supplied via your process manager, or loaded using Node's--env-fileflag.