Skip to content

Repository files navigation

GitHub Roast πŸ”₯

GitHub Roast turns any public GitHub profile into a brutally honest developer review.

Enter a GitHub username, and the app analyzes public profile data such as repositories, activity, languages, coding consistency, commit habits, and overall developer behaviour. It then generates a personalized roast based on the actual GitHub profile.

No random insults. Your own GitHub history provides the material.

Your code may compile. Your GitHub profile may not survive.

How It Works

GitHub Username
      ↓
GitHub API
      ↓
Profile Data Analysis
      ↓
AI-Generated Roast
      ↓
Developer Score and Insights

The application:

  1. Fetches public GitHub profile and repository data.
  2. Extracts useful developer statistics and coding patterns.
  3. Sends the analyzed data to an AI model.
  4. Generates a funny, personalized GitHub roast.
  5. Displays the roast, scores, and profile insights.

Tech Stack

  • Next.js β€” frontend and backend API routes
  • TypeScript β€” type-safe development
  • React β€” user interface
  • Tailwind CSS β€” styling
  • shadcn/ui β€” reusable UI components
  • GitHub REST API β€” public profile and repository data
  • AI API β€” personalized roast generation
  • Vercel β€” deployment

Run Locally

1. Clone the repository

git clone https://github.com/Kalyan-github-4/GitHub-Roast.git

2. Open the project

cd GitHub-Roast

3. Install dependencies

npm install

4. Create the environment file

Create a .env.local file in the project root:

GITHUB_TOKEN=your_github_personal_access_token
AI_API_KEY=your_ai_api_key

Use the exact environment variable names expected inside your project API route.

A GitHub token is recommended because unauthenticated GitHub API requests have lower rate limits.

5. Start the development server

npm run dev

Open the application at:

http://localhost:3000

Available Commands

Start the development server:

npm run dev

Create a production build:

npm run build

Run the production build locally:

npm run start

Run code checks:

npm run lint

Production Build

Before deployment, verify that the application builds successfully:

npm run build

Then test the production version locally:

npm run start

Deployment

The project can be deployed directly to Vercel.

  1. Push the project to GitHub.
  2. Import the repository into Vercel.
  3. Add the required environment variables.
  4. Keep the framework preset set to Next.js.
  5. Leave the output directory empty or set it to the Next.js default.
  6. Deploy the project.

Vercel will automatically run:

npm run build

Privacy

GitHub Roast only analyzes publicly available GitHub information. It does not require access to private repositories.

The project is built for entertainment and developer feedback. Roasts focus on coding activity and GitHub habits rather than personal characteristics.

License

MIT Β© Kalyan Manna


Built for developers who are brave enough to submit their GitHub username.

About

Your GitHub profile, roasted by AI β€” repos, commit messages, dead projects and all. No login, just pain. 🌢️ Enter a GitHub username β†’ AI analyzes real profile signals β†’ brutal (but loving) roast. Shareable stat cards included.

Resources

Stars

4 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages