Portfolio & GitHub Profile

GitHub · README · Deploy · LinkedIn · Checklist

mitraaiprojects.com

GitHub Profile README

# Hi, I'm [Your Name] 👋
🎓 B.Tech CSE | [College] | 2025
🤖 Building: LLMs, RAG, Computer Vision
📍 [City, India]

## 🛠 Stack
Python · PyTorch · LangChain · FastAPI
scikit-learn · Docker · GitHub Actions

## 🚀 Pinned Projects
| Project | Tech | Demo |
|---|---|---|
| [Doc Q&A](link) | RAG+FastAPI | [Live](url) |
| [Forecasting](link) | ARIMA+Streamlit | [Live](url) |

## 📫 Connect
[![LinkedIn](badge)](linkedin-url)
[![HuggingFace](badge)](hf-url)

Project README Must-Haves

🎯 One-line description — what it does
🖼 Screenshot / GIF — show don't tell
🔗 Live demo URL badge
🏗 Architecture diagram (Mermaid or draw.io)
✨ Features list — 4–6 bullet points
🚀 Quick start — copy-paste commands
📁 Project structure — key files explained
🛠 Tech stack table
📜 License (MIT for student projects)

Deploy for Free

Platform	Best for	Free tier
Render.com	FastAPI, Streamlit	Sleeps after 15min idle
Streamlit Cloud	Streamlit only	Public apps don't sleep
HuggingFace Spaces	ML demos with GPU	Free T4 GPU for demos
Railway.app	Any framework	$5 free credit/month
Vercel	Next.js, static	Generous free tier
GitHub Pages	Static HTML/docs	Free unlimited public

LinkedIn Optimisation

Section	What to add
Photo	Clear, professional headshot
Headline	"ML Engineer \| Python · LLMs \| Open to 2025 Roles"
About	3 projects + skills + availability
Featured	Top 3 project demo URLs
Skills	Python, ML, DL, GenAI, LangChain, Docker (get endorsements)
Certificates	Add Mitra AI Projects completion certificates

Portfolio Checklist

✅ Profile photo + real name on GitHub
✅ Bio: role + 3 skills + location
✅ 6 pinned repos (not forks!)
✅ Every repo has README + demo URL
✅ Green contribution graph (commit regularly)
✅ At least 1 major deployed project
✅ At least 1 DL/CV project on HF Spaces
✅ .gitignore excludes .env and model files
✅ Descriptive commit messages (feat/fix/docs)
✅ LinkedIn featured section with project links
✅ Kaggle profile with 2+ notebooks

Commit Message Convention

feat: add PDF upload support
fix:  resolve CORS error in production
docs: update README with deploy steps
test: add unit tests for scoring module
refactor: extract scoring to service layer
perf: cache embeddings to reduce API calls
chore: update dependencies to latest

# Format: type(scope): description
feat(auth): add Google OAuth login
fix(api): handle empty document gracefully

# Breaking changes
feat!: redesign scoring API
BREAKING CHANGE: response format changed

Shortlist-Ready Profile Score

Score	Status
0–40%	Recruiters likely skip your profile
41–75%	Getting noticed in some searches
76–100%	Portfolio-ready — strong shortlisting

Check your score at: mitraaiprojects.com/portfolio-guide.html