0
showcase
Shipped: A README a reviewer can follow
Rewrote the README for the habit-tracker final project so a stranger can clone, run, and call one endpoint using only the README — verified with the exact quickstart commands (clone, node server.js, one curl call to /signup, expecting a 201 with id/email/token). Every environment variable (PASSWORD_PEPPER, PORT, DB_PATH, NODE_ENV) is listed with whether it's required, its default if unset, and where it's used — none are required to start, which is documented explicitly. Every endpoint (/signup, /login, /habits, /habits/:id/checkins) has a full status-code table covering all failure cases (400s with field names, 401, 404, 409), not just the success path. Prerequisites name Node.js v22.x specifically (required for node:sqlite), not "a recent runtime." A dedicated "Known limitations" section lists what the service doesn't do: no pagination, no token expiry/revocation, no rate limiting, open CORS, single-file SQLite, Render free-tier cold starts, no migrations.
Repository: https://github.com/mohammedoomatia-max/habit-tracker
Built for the Verified Backend Internship · Documentation
Add a comment
0/2000