TechnicalCollectible prompt
README for your web project, written from the code
Act as a senior developer writing the README for this {{tech_stack}} project, live at {{website_url}}. Read the codebase, config files and scripts first. Write only what the code confirms, and run each setup command to check it works.
Sections:
1. What it is, who it's for, and the live URL, in three sentences
2. Tech stack with versions
3. Getting started: prerequisites, install, and the one command to run it locally
4. Environment variables: a table with name, purpose, whether it's secret, where to get it, and a fake example value; create a matching example env file if there isn't one. Never include real keys
5. Database: how to create it, run migrations and load seed data
6. Scripts: what each one does
7. Project structure: the main folders and what lives where
8. Deployment: where it's hosted, how deploys happen, and how preview builds work
9. Tests and checks to run before merging
10. Troubleshooting: the errors a new developer is most likely to hit, with fixes
11. Conventions, and who to ask
Keep it scannable, with short sentences and code only where a command is needed. Mark anything you couldn't confirm as TODO. When you're done, list the commands that failed and anything you assumed.
Technicalnvoka.com/library/nvoka-readme-for-your-web-projectScan to open
Technical
README for your web project, written from the code
Write a README from the actual code: setup, environment variables, deploys and troubleshooting.
Curated by Nvoka
Claude CodeCodexCursorGitHub Copilot
Make it yours
Fill in the blanks and change any word. Only your copy changes, never the card.
Fill in the blanks
0 of 2 filledYour prompt
Act as a senior developer writing the README for this {{tech_stack}} project, live at {{website_url}}. Read the codebase, config files and scripts first. Write only what the code confirms, and run each setup command to check it works.
Sections:
1. What it is, who it's for, and the live URL, in three sentences
2. Tech stack with versions
3. Getting started: prerequisites, install, and the one command to run it locally
4. Environment variables: a table with name, purpose, whether it's secret, where to get it, and a fake example value; create a matching example env file if there isn't one. Never include real keys
5. Database: how to create it, run migrations and load seed data
6. Scripts: what each one does
7. Project structure: the main folders and what lives where
8. Deployment: where it's hosted, how deploys happen, and how preview builds work
9. Tests and checks to run before merging
10. Troubleshooting: the errors a new developer is most likely to hit, with fixes
11. Conventions, and who to ask
Keep it scannable, with short sentences and code only where a command is needed. Mark anything you couldn't confirm as TODO. When you're done, list the commands that failed and anything you assumed.