Skip to content

README.md

Latest commit

 

History

History
268 lines (190 loc) · 6.47 KB

README.md

File metadata and controls

268 lines (190 loc) · 6.47 KB

🔥 GitRoast - Seinfeld Style GitHub Roaster

"What's the deal with your GitHub profile?"

A hilarious web app that roasts GitHub profiles using classic Seinfeld observational comedy style.

🎯 What It Does

Enter any GitHub username → Get absolutely roasted in Jerry Seinfeld's voice

Example Roasts:

  • "Zero followers! ZERO! You know what that is? That's not even your mom following you!"
  • "47 repositories?! What are you, a digital hoarder?"
  • "Your last commit was WHEN? This profile is like a museum of abandoned dreams!"

✨ Features

  • ✅ Pure Seinfeld Comedy - Observational humor about your GitHub habits
  • ✅ No AI APIs - All roasts are algorithmically generated
  • ✅ Instant Results - Uses GitHub's public API
  • ✅ Shareable - Copy roasts to share on Twitter
  • ✅ 100% Free - No rate limits, no API keys needed
  • ✅ Works with any public GitHub profile

🚀 Quick Start

# Clone or navigate to directory
cd gitroast

# Install dependencies
npm install

# Run development server
npm run dev

# Open http://localhost:3000

That's it! 🎉

🎮 How to Use

  1. Enter a GitHub username (or paste full URL)

    • Works: octocat or github.com/octocat

  2. Click "Roast My GitHub!"

  3. Get roasted in pure Seinfeld style

  4. Share the roast - Copy button included

🎯 What Gets Roasted

The app analyzes:

  • 📊 Follower/following ratio
  • 📁 Number of repos (too many? too few?)
  • ⭐ Star counts
  • 🍴 Fork vs original ratio
  • 📝 Bio quality
  • 💬 Commit activity
  • 🎨 Repo naming
  • 📅 Account age vs activity
  • 🖼️ Profile picture

💡 Example Usernames to Try

  • torvalds (Linus Torvalds)
  • gaearon (Dan Abramov)
  • sindresorhus (prolific open source dev)
  • tj (TJ Holowaychuk)
  • Your own username!

🎨 Tech Stack

  • Next.js 14 - React framework
  • Tailwind CSS - Styling
  • GitHub API - Profile data (no auth needed)
  • Pure JavaScript - No AI, no external APIs

📦 Project Structure

gitroast/
├── app/
│   ├── page.jsx       # Main component (all the magic)
│   ├── layout.jsx     # App wrapper
│   └── globals.css    # Tailwind styles
├── package.json
├── tailwind.config.js
└── README.md

🚢 Deploy to Vercel (30 seconds)

# Install Vercel CLI
npm i -g vercel

# Deploy
vercel

# Done! Get your live URL

Or connect GitHub repo to Vercel dashboard for auto-deployments.

🎯 How the Roasting Works

The app uses algorithmic roast generation:

  1. Fetches GitHub profile data via public API
  2. Analyzes various metrics (repos, followers, activity)
  3. Matches patterns to pre-written Seinfeld-style jokes
  4. Combines jokes into a coherent roast routine
  5. Delivers it in classic Seinfeld observational style

No AI needed - Just clever JavaScript and comedy writing!

🌟 Why This Works

Viral Potential:

  • 🔥 People LOVE being roasted
  • 😂 Seinfeld humor is universally appreciated
  • 📱 Easy to share on social media
  • 🎯 Targets developers (huge audience)

Technical Showcase:

  • Clean React code
  • API integration
  • Real-time data processing
  • Responsive design

Fun Factor:

  • Lighthearted comedy
  • No harsh personal attacks
  • Roasts the CODE, not the person

🎤 Sample Roast Output

So I'm looking at John Doe's GitHub profile...

No bio? What's the deal with that? You've got 23 repositories 
but can't write ONE sentence about yourself? That's like showing 
up to a party and refusing to say your name.

47 followers? I've seen more people show up to a dentist 
appointment. And nobody WANTS to be there!

Your last commit was WHEN? This profile is like a museum. 
A museum of abandoned dreams! Even the tumbleweeds are asking 
"Is anyone coming back?"

But hey, what do I know? Maybe in an alternate universe, 
this profile is CRUSHING it. But in THIS universe? 
...Yeah, you might wanna push some code.

🔧 Customization Ideas

Want to extend it? Add:

  • Different comedy styles (Chris Rock, John Mulaney, etc.)
  • Roast intensity levels (mild, medium, brutal)
  • Share to Twitter button with pre-filled text
  • Roast history - Save past roasts
  • GitHub Actions integration - Auto-roast on push
  • Leaderboard - Most/least roasted profiles

📱 Social Sharing

Users can copy roasts to share on:

  • Twitter/X
  • Reddit (r/ProgrammerHumor)
  • LinkedIn (if brave)
  • Discord developer servers
  • Slack channels

🎯 Target Audience

  • Developers looking for laughs
  • Students wanting portfolio humor
  • Tech Twitter users
  • Anyone on GitHub

💰 Monetization Ideas (Optional)

  • Premium roasts - Longer, more detailed ($1.99)
  • Custom roast styles - Other comedians
  • Sponsored roasts - Companies can sponsor
  • Merch - "I got roasted by GitRoast" shirts
  • API access - For other apps

🐛 Known Limitations

  • GitHub API has rate limits (60 requests/hour for unauthenticated)
  • Only works with public profiles
  • Roasts are algorithmic (not AI-generated)
  • May be less funny for very new profiles

📈 Going Viral Strategy

  1. Post on Twitter with screenshot
  2. Share on Reddit (r/programming, r/webdev)
  3. Post on Hacker News
  4. Share in Discord communities
  5. Email to tech newsletters
  6. Submit to Product Hunt

🤝 Contributing

Want to add more roasts? Edit the generateSeinfeldRoast function in app/page.jsx

Ideas for new roast patterns:

  • Commit message quality
  • README length
  • Issue/PR responsiveness
  • Contribution graph patterns

📄 License

MIT - Do whatever you want!

🎉 Credits

Built with ❤️ and comedy

Inspired by:

  • Jerry Seinfeld's observational humor
  • GitHub's public API
  • The urge to roast every developer

🚀 Next Steps

  1. Run it locally - npm run dev
  2. Try your username - Get roasted!
  3. Deploy to Vercel - Share with the world
  4. Post on social media - Watch it go viral
  5. Add to portfolio - Show off your work

Remember: It's all in good fun! The roasts are lighthearted and meant to make you laugh, not cry. 😂

Now go roast some profiles! 🔥

🆘 Troubleshooting

"User not found"

  • Check spelling
  • Make sure profile is public

"Rate limit exceeded"

  • Wait an hour
  • Or add GitHub token (optional)

App won't start

  • rm -rf node_modules && npm install
  • Check Node.js version (18+ required)

Styles look broken

  • Clear browser cache
  • npm run build then npm start

Built in a day. Ready to go viral tomorrow. 🚀🔥