Portfolio and README Guide
A project is only as valuable as your ability to show and explain it.
README template
# Project name
One sentence: what it does and who it is for.
 <!-- or a short GIF -->
**Live demo:** https://...
## Features
- Feature one
- Feature two
## Tech stack
React, Node.js, PostgreSQL, Redis, Docker
## Architecture
Short paragraph or a diagram of the main components.
## Getting started
git clone ...
npm install
cp .env.example .env
npm run dev
## Tests
npm test
## What I learned / design decisions
- Why I chose X over Y
- A hard bug and how I fixed it
## Roadmap
- [ ] Next feature
Quality signals
| Signal | How |
|---|---|
| Works for others | Clear setup steps; .env.example; no secrets committed |
| Tested | Unit tests for core logic; CI badge |
| Deployed | Free hosting (static host, container platform) and a working link |
| Maintained | Small, meaningful commits; issues and a changelog |
| Documented decisions | An "Architecture" or "Design decisions" section |
Security hygiene
- Never commit API keys, tokens or passwords. Use environment variables and a
.env.example. - Add
.envto.gitignorebefore the first commit. - If you leak a secret, revoke it immediately; deleting the file is not enough.
Portfolio site checklist
- 3 to 5 best projects with live links and repository links
- A short "About" section and a way to contact you
- Fast and responsive on mobile
- Accessible (alt text, contrast, keyboard navigation): see Performance and accessibility
- Resume PDF available: see Resume guide
Talking about a project in interviews
Prepare a 2-minute story: problem, approach, hard part, result, what you would improve. Be ready to whiteboard the architecture and the data model.
Loading Comments...