Skip to content

GitHub Profile Battleground. A platform where GitHub profiles are compared by AI, showcasing the coding champs and humorously trolling the underdogs.

Notifications You must be signed in to change notification settings

aakashsaini09/github-roast

Repository files navigation

🔰 Github-roast

  • Use AI to analyze and compare two GitHub profiles. Get praised, get roasted, and most importantly, have fun! Also, see a Chart Comparison between both profiles.

  • Web build deployed on vercel under free tier Link.

📚 Tech Stack

  • Next.js
  • Tailwind CSS
  • Shad-CN (UI Component)
  • Github API
  • Gemini API

🔩 Environment Variables

  • The environment variables are configured in .env.example file
  • NEXT_PUBLIC_GEMINI_API_KEY=

🔨 Setting Up

Follow the following instructions to set up the project and run it locally

  • Run npm install to install all the dependencies.
  • Run npm run dev to start the development server.
  • Get your API key from Gemini and paste it into the .env file with NEXT_PUBLIC_GEMINI_API_KEY this name.
  • To make a web build run npm run build and the build files will be generated in the dist folder.

⚡ Features

  • The app takes your GitHub username and compares it with the other user's profile you have entered.
  • Based on the comparison it trolls you or praises you.
  • See the detailed analyses/comparison with the graph at the bottom of the page.
  • Set the mode to dark/light according to your need.

📁 File Structure :

.
├── assets
│   │── images
│   │   
│   │── favicon.png
│   │── splash.png
│   │── icon.png
│   └── adaptive-icon.png
├── components
│   │── UI
│   │── └── ... ShadCn Components
│   │── Cart.tsx
│   │── Chart.tsx
│   │── Footer.tsx
│   │── Mode-toggle.tsx
│   └── Navbar.tsx
├── app
│   └── ... /(root)/github
├── └── page.tsx
├── └── layout.tsx
├── .env.example
├── package.json
├── package-lock.json
├── README.md
└── .gitignore

Support

If you like this project, give it a ⭐

About

GitHub Profile Battleground. A platform where GitHub profiles are compared by AI, showcasing the coding champs and humorously trolling the underdogs.

Topics

Resources

Security policy

Stars

Watchers

Forks