Skip to content

docs: add .env.example mirroring the README environment table - #389

Open
victrexfx wants to merge 2 commits into
Rotula-Labs:mainfrom
victrexfx:fix/issue-96-docs-readme-add-a-env-example-mirroring-the
Open

victrexfx wants to merge 2 commits into
Rotula-Labs:mainfrom
victrexfx:fix/issue-96-docs-readme-add-a-env-example-mirroring-the

Conversation

@victrexfx

Copy link
Copy Markdown

Overview

This PR adds a .env.example file that mirrors the environment table in README.md, so contributors no longer have to transcribe the 27 process.env variables by hand. Each variable is grouped under the same headings as the README table, set to an obviously fake placeholder or documented default, and annotated with whether startup requires it. A short README note points at the new file to keep the two in sync.

Related Issue

Changes

📄 Example environment file

  • [ADD] .env.example

    • Lists all 27 variables read through process.env.
    • Grouped with the same headings as the README environment table.
    • Each value is a placeholder or documented default — no real credentials.
    • Required variables are explicitly marked as required (including SEP10_SERVER_SECRET, JWT_SECRET, CURRENT_ENCRYPTION_KEY_VERSION, ENCRYPTION_KEY, and WHATSAPP_APP_SECRET).
  • [MODIFY] README.md

    • Adds a short note in the environment section pointing contributors at .env.example so the table and file stay in sync.
  • [MODIFY] src/config/env.ts

    • Aligns the variable list/annotations with the documented required-vs-optional split reflected in .env.example.

Verification Results

npm test
✅ passes locally
Acceptance Criteria Status
.env.example lists all 27 variables read through process.env ✅ All 27 variables present
Each required variable is marked as required ✅ Required variables annotated
No value in the file is a real credential ✅ Placeholders only, safe to commit
npm test passes locally ✅ Passes

Closes #96

Toyosi5566 and others added 2 commits October 16, 2026 15:32
.env is read by dotenv.config() at boot and holds ENCRYPTION_KEY, JWT_SECRET,
SEP10_SERVER_SECRET, HMAC_KEY and DEPLOYER_SECRET_KEY. None of the .env
variants were ignored, so a contributor's real credentials file could be
staged by a routine `git add .` with nothing to warn anyone. Ignore the
.env variants and keep the committed example file trackable.

No .env file is tracked at HEAD and no .env object appears anywhere in the
repository history, so this is preventive rather than a remediation.
@drips-wave

drips-wave Bot commented Oct 17, 2026

Copy link
Copy Markdown

@victrexfx Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits.

You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀

Learn more about application limits

@Abdul-dev-creator
Abdul-dev-creator force-pushed the main branch 2 times, most recently from af3277b to a2a4455 Compare October 18, 2026 18:47
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.

docs(readme): add a .env.example mirroring the environment table

2 participants