The ultimate AI-powered roaster for your GitHub profile.

Overview

Github Burner is a brutally honest, AI-driven application that analyzes any GitHub profile and generates a hilarious, "nuclear-level" roast of their repositories, commit history, and coding habits. Powered by the Gemini API, it deeply inspects repositories, languages, and profile stats to deliver personalized roasts.

Features

• Deep Profile Analysis: Fetches your repositories, languages, and stats directly from GitHub.
• AI-Powered Roasts: Uses Gemini AI to construct hyper-personalized, brutal roasts based on your actual code and habits.
• Dynamic Theming: Beautiful dark/light mode UI with smooth micro-animations.
• Social Sharing: One-click sharing to X (Twitter) and LinkedIn.
• Export Options: Export your roast as a PDF or JSON for safekeeping.
• Custom API Key Support: Use your own Gemini API key directly from the UI to bypass rate limits.

---

Getting Started Locally

Want to run Github Burner on your own machine? Follow these steps:

Prerequisites

• Node.js (v18 or higher)
• npm or bun

1. Clone & Install

Clone the repository and install the dependencies:

git clone https://github.com/karthik558/GithubBurner.git
cd GithubBurner
npm install

2. Run the App

Start both the React frontend and the Express backend using the dev script:

npm run dev

3. Configure the Gemini API Key

Open your browser and navigate to http://localhost:3000. When launching the application, you can easily paste your Gemini API Key directly into the input field provided in the UI.

The application will securely save your key to your browser's local storage so you won't need to enter it again on subsequent visits. No .env files required for local usage!

---

Deploying Online

Github Burner is built with Vite (React) for the frontend and Express for the backend. You can seamlessly deploy it to modern hosting platforms such as Vercel, Render, or Cloudflare.

Deployment Best Practices

When deploying to production, it is highly recommended to configure your API keys as secure environment variables (Secrets) through your hosting provider's dashboard. This ensures your keys remain hidden from the public client.

1. Vercel / Cloudflare / Render: Create a new web service or project and connect your GitHub repository.
2. Build Settings:
   • Build Command: npm run build
   • Start Command: npm run start (For Node.js environments like Render).
3. Environment Secrets: In your deployment dashboard, navigate to the Environment Variables or Secrets section and securely add:
   • GEMINI_API_KEY: Your primary Google Gemini API Key.
   • GITHUB_TOKEN (Optional): A GitHub Personal Access Token to prevent aggressive rate limiting when fetching profile data.
4. Deploy: Trigger a deployment. Your application will be built and automatically served.

Note: For serverless environments like Vercel or Cloudflare, ensure your deployment configuration is set to support serverless Node.js execution for the Express backend.