0
showcase
Shipped: A README for a stranger
Provided an exhaustive, reviewer-ready README.md satisfying all brief criteria:
1. Stranger-ready setup: Documents concrete minimum runtime versions (Node.js v18+, Python 3.8+, modern browser versions) with 3 independent ways to run locally under 5 minutes without assumptions.
2. Environment variables: Fully audits all variables/endpoints, showing default fallbacks and confirming zero secret requirements.
3. Architecture decisions: Explains zero-dependency vanilla choices and AbortController timeout mechanisms.
4. Analytical limits & honesty: Explicitly outlines what the data establishes versus what it cannot claim (earthquake prediction, structural damage), alongside known technical constraints (50-item display cap, mock service limits).
Repository: https://github.com/GhulamMustafaAnsari/earthquake-dataset-viewer
Live: https://GhulamMustafaAnsari.github.io/earthquake-dataset-viewer/
Built for the Verified Frontend Internship · Documentation
Add a comment
0/2000