Documentation Gap
File: backend/README.md
Problem
The backend README is entirely the default NestJS starter template. It contains no information specific to this project — it references Kamil Myśliwiec (the NestJS author), NestJS Mau, and generic NestJS resources. A contributor opening this file learns nothing about the Health-chain-stellar backend.
Missing entirely:
- What modules exist and what each one does (auth, blood-matching, inventory, orders, custody, soroban, etc.)
- Required environment variables (database URL, JWT secret, Redis URL, Soroban RPC, etc.)
- How to run the test suite for this specific project
- How the backend connects to the Soroban contracts
- API base URL and link to Swagger docs
- Database migration instructions (a separate
MIGRATION_POLICY.md exists but is never linked from the README)
Proposed Structure
# Health-chain-stellar Backend
NestJS API server for the Health-chain-stellar platform.
## Modules
- **auth** — JWT authentication, sessions, RBAC
- **blood-matching** — ABO/Rh compatibility engine
- **inventory** — Blood stock management with optimistic locking
- **orders** — Blood request lifecycle
- **soroban** — Stellar smart contract integration (BullMQ queue)
- ...
## Environment Variables
| Variable | Required | Description |
|---|---|---|
| DATABASE_URL | ✅ | PostgreSQL connection string |
| REDIS_URL | ✅ | Redis connection string |
| JWT_SECRET | ✅ | HS256 signing key |
| SOROBAN_RPC_URL | ✅ | Stellar RPC endpoint |
| ... | | |
## Quick Start
...
Documentation Gap
File:
backend/README.mdProblem
The backend README is entirely the default NestJS starter template. It contains no information specific to this project — it references Kamil Myśliwiec (the NestJS author), NestJS Mau, and generic NestJS resources. A contributor opening this file learns nothing about the Health-chain-stellar backend.
Missing entirely:
MIGRATION_POLICY.mdexists but is never linked from the README)Proposed Structure