Skip to content

[Docs] README understates required env and omits CI, schedulers and webhook security setup #21

Description

@grantfox-oss

Telegram (ask questions / claim the issue here first): https://t.me/+DOylgFv1jyJlNzM0

Why this matters

README.md states Node 18+ while the Dockerfile pins node:22-alpine, and it does not document the many required env vars in .env.example (contract IDs, admin secret, score deltas), the background schedulers, or webhook secret/HMAC verification, making onboarding error-prone.

Acceptance criteria

  • Align the documented Node version with the Dockerfile and engines
  • Document all required env vars (cross-referencing .env.example) and which are mandatory at startup
  • Describe the background jobs (indexer, default checker, webhook retry, reconciliation, cleanup, loan-due cron)
  • Document how webhook HMAC signatures (x-remitlend-signature) are produced and verified

Files to touch

  • README.md
  • .env.example
  • src/config/env.ts
  • src/services/webhookService.ts

Out of scope

  • Generating API reference docs
  • Architecture diagrams

Metadata

Metadata

Assignees

Labels

GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official CampaigndocumentationImprovements or additions to documentationgood first issueGood for newcomers

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions