Link to the app - https://app-roast-app-sv5hwnu7ktv6esvf95d3hh.streamlit.app/
GitHub Roast App is a fun, interactive application that humorously analyzes a developer's GitHub profile, repos, and README files. Whether you're looking for gentle feedback or an all-out roast, this app delivers it with witty humor and a tech-savvy twist, specially tailored for Indian developers and students.
Users can choose their preferred roast level—Easy, Medium, or Harsh—and the app generates personalized feedback using Google’s Gemini AI model.
-
Roast Levels:
- Easy: Light-hearted comedy, some constructive feedback, and motivational comments for a gentle roast.
- Medium: A harsher tone with sarcastic comments but still offering some advice.
- Harsh: Full-on roast! Brutal, no mercy, pure savage humor, burning the GitHub profile alive like a Bollywood villain.
-
Profile Analysis:
- Fetches GitHub user data such as name, bio, number of public repos, and followers.
- Analyzes the user’s repositories and summarizes the README files.
-
Tailored for Indian Devs:
- Roasts infused with techie and Bollywood humor, keeping it relatable and fun!
- Python for backend logic.
- Streamlit for the interactive web app interface.
- GitHub API to fetch user data and repositories.
- Google Gemini AI for generating creative roast responses.
- dotenv for secure handling of API keys.
to be added Screenshot of the roast in action
Follow these steps to set up the GitHub Roast App locally.
-
Clone the repository:
git clone https://github.com/sanskaryo/github-roast-app.git cd github-roast-app -
Install dependencies: Make sure you have Python installed. Install required packages by running:
pip install -r requirements.txt
-
Configure environment variables: Create a
.envfile in the root directory and add your Google API key:GOOGLE_API_KEY=your-google-api-key
-
Run the app: Start the Streamlit app with:
streamlit run app.py
-
Open in browser: After running the app, open http://localhost:8501 in your browser to use the GitHub Roast App.
- Enter the GitHub Username: Enter the username of the GitHub profile you want to roast.
- Choose Roast Level: Select Easy, Medium, or Harsh depending on how intense you want the roast to be.
- Hit "Roast Me!": Let the app work its magic, fetching the profile, analyzing it, and generating a hilarious roast.
- Enjoy the Roast: Sit back and enjoy the creative, funny, and witty roast generated by the AI!
We use Google Gemini AI (1.5 flash model) to generate witty and humorous roast content. The app analyzes the user's profile, projects, and README files, combining them into a clever and sometimes brutal roast.
- GitHub API: Used to fetch GitHub user data, including repositories, bio, and README files.
- Google Gemini API: Powers the roast generation by processing the data and prompt.
Contributions are welcome! If you’d like to improve the app or fix any issues, feel free to fork this repository, make your changes, and submit a pull request.
- Fork the project
- Create your feature branch (
git checkout -b feature/YourFeature) - Commit your changes (
git commit -m 'Add YourFeature') - Push to the branch (
git push origin feature/YourFeature) - Open a pull request
- Thanks to Streamlit for providing a great tool to build interactive web apps.
- Thanks to Google's Gemini AI for powering the roasts.
- GitHub for providing the API to fetch user data.
This project is licensed under the MIT License. See the LICENSE file for more details.
Made with ❤️ by Sanskar
email - [email protected]
Feel free to reach out if you have any questions or suggestions!