Enter your GitHub username above to begin your portfolio audit.
๐ก How to Improve Your Portfolio
๐
Great READMEs
๐
Pinning Repos
๐ค
Profile Setup
โ๏ธ
Commit Messages
๐ท๏ธ
Project Naming
๐
Live Demos
๐ค
Open Source
๐
GitHub Pages
๐ Copy-Paste Templates
๐ Project README Template
# Project Name
> One-line description of what this project does.
## ๐ Live Demo
[View Demo](https://your-demo-link.com) ยท [Report Bug](https://github.com/you/repo/issues)
## โจ Features
- Feature one โ what it does
- Feature two โ what it does
- Feature three โ what it does
## ๐ ๏ธ Built With
- [React](https://react.dev/) โ UI framework
- [Node.js](https://nodejs.org/) โ Backend runtime
- [PostgreSQL](https://postgresql.org/) โ Database
## ๐ฆ Getting Started
### Prerequisites
- Node.js v18+
- npm or yarn
### Installation
```bash
git clone https://github.com/you/project-name.git
cd project-name
npm install
npm run dev
```
## ๐ Usage
Brief explanation of how to use the project with a code snippet or screenshot.
## ๐ค Contributing
Pull requests are welcome. For major changes, open an issue first.
## ๐ License
[MIT](LICENSE)
๐ค GitHub Profile README Template
# Hi there, I'm [Your Name] ๐
๐ **[Your Role]** at **[Your School/Company]**
๐ Based in **[City, Country]**
๐ญ Currently working on **[current project]**
๐ฑ Learning **[skill you're developing]**
๐ฌ Ask me about **[your expertise]**
๐ซ Reach me at **[email or LinkedIn URL]**
---
## ๐ ๏ธ Tech Stack
**Languages:** Python ยท JavaScript ยท TypeScript ยท Go
**Frontend:** React ยท Next.js ยท Tailwind CSS
**Backend:** Node.js ยท FastAPI ยท PostgreSQL
**Tools:** Git ยท Docker ยท GitHub Actions ยท Figma
---
## ๐ Featured Projects
| Project | Description | Stack |
|--------|-------------|-------|
| [Project A](link) | What it does | React, Node |
| [Project B](link) | What it does | Python, ML |
| [Project C](link) | What it does | Go, Docker |
---
## ๐ GitHub Stats

---
โญ *If you find my projects helpful, consider starring them!*
โ๏ธ Good Commit Message Examples
# Format: : (50 chars max)
# Body: explain WHY, not WHAT (wrap at 72 chars)
# โ GOOD EXAMPLES
feat: add user authentication with JWT
fix: resolve null pointer error on login page
docs: update README with deployment instructions
refactor: extract validation logic into helper
test: add unit tests for payment module
chore: upgrade dependencies to latest stable
style: format code with prettier
perf: cache API responses to reduce load time
# Bad โ Good rewrites:
# โ "fixed stuff" โ โ "fix: resolve crash when cart is empty"
# โ "update" โ โ "docs: add API endpoint documentation"
# โ "wip" โ โ "feat: add draft order functionality (in progress)"
# โ "changes" โ โ "refactor: simplify auth middleware logic"
# Types: feat | fix | docs | style | refactor | test | chore | perf | ci
๐ท๏ธ Repo Description Examples
# Formula: [What it does] + [who it's for] + [key differentiator]
# Keep under 100 characters. No period at end.
# โ GOOD DESCRIPTIONS
"Flashcard app for medical students with spaced repetition and progress tracking"
"CLI tool to auto-generate git commit messages using OpenAI GPT-4"
"Next.js e-commerce starter with Stripe, Auth.js, and dark mode out of the box"
"Chrome extension that summarizes any webpage in 3 bullet points"
"REST API for task management with real-time WebSocket notifications"
"Portfolio site built with React + Framer Motion โ 100 Lighthouse score"
"Discord bot that posts daily LeetCode challenges to your server"
"Python script to batch-resize images and upload them to S3"
# โ AVOID
"my project"
"test"
"This is a web app I built for a class project in 2023 using various technologies"
"TODO: add description"