https://github.com/jacksonkasi0/roast-me
Roast Me is a fun and interactive web app that generates humorous, AI-powered roasts based on GitHub profile READMEs. Just input a GitHub profile URL and enjoy the laughs!
https://github.com/jacksonkasi0/roast-me
dev github-copilot llm roast
Last synced: about 2 months ago
JSON representation
Roast Me is a fun and interactive web app that generates humorous, AI-powered roasts based on GitHub profile READMEs. Just input a GitHub profile URL and enjoy the laughs!
- Host: GitHub
- URL: https://github.com/jacksonkasi0/roast-me
- Owner: jacksonkasi0
- Created: 2025-01-11T16:32:07.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2025-01-12T04:51:23.000Z (5 months ago)
- Last Synced: 2025-04-24T10:49:36.835Z (about 2 months ago)
- Topics: dev, github-copilot, llm, roast
- Language: TypeScript
- Homepage: https://roast-u.vercel.app
- Size: 114 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🔥 Roast Me - GitHub Profile Roaster
**Roast Me** is a fun and interactive web app that generates humorous, AI-powered roasts based on GitHub profile READMEs. Just input a GitHub profile URL and enjoy the laughs!
⚠️ **Disclaimer**: Roasts are generated by an AI model and may not always be accurate or appropriate. Please use this app responsibly and respectfully.
## ✨ Features
- Generate friendly, funny roasts with emojis 🤖🎉
- Simple, responsive UI built with Next.js and TailwindCSS
- Social sharing options for Twitter and LinkedIn 🔗
- GitHub avatar and profile integration 👤
- **Watch the build process on YouTube!** 🎥
## 🛠️ Tech Stack
- **Frontend**: Next.js, TypeScript, TailwindCSS
- **Backend**: Next.js API Routes
- **AI Model**: LLM (e.g., GPT-4 mini or llama 3.2) [sambanova.ai](https://sambanova.ai)
- **API Integration**: GitHub API
## 🚀 Getting Started
### Clone the Repository
```bash
git clone https://github.com/jacksonkasi0/roast-me.git
cd roast-me
```
### Install Dependencies
```bash
bun install
```
### Set Up Environment Variables
Create a `.env` file in the root directory and add:
```env
OPENAI_API_KEY=your_openai_api_key
```
### Run the Development Server
```bash
bun dev
```
Visit [http://localhost:3000](http://localhost:3000) to view your app.
## 🌟 Usage
1. Enter a GitHub profile URL.
2. Click "Roast Me!" to generate a roast.
3. Share the roast on Twitter or LinkedIn.
4. Have fun! 😄
## 📺 Watch the Build
Check out the full development journey in my YouTube video, where I recorded the entire build from scratch:
[📺 Watch the Full Build Video on YouTube](https://youtu.be/KBRR1OdD-ik)
## 🌐 Live Demo
Experience the fun firsthand by trying out the **"Roast Me"** app:
- **Live Demo:** [roast-u.vercel.app](https://roast-u.vercel.app/)
- Enter any GitHub profile URL.
- Click the **"Roast Me!"** button.
- Enjoy a personalized, funny roast based on the profile’s `README.md`.
## 🤝 Contributing
Contributions are welcome!
1. Fork the repository.
2. Create a new branch: `git checkout -b feature/YourFeature`.
3. Commit changes: `git commit -m 'Add YourFeature'`.
4. Push to the branch: `git push origin feature/YourFeature`.
5. Open a Pull Request.
## 📝 License
This project is licensed under the MIT License.
## 📬 Contact
- **GitHub**: [Jackson Kasi](https://github.com/jacksonkasi0)
- **Live Demo**: [roast-u.vercel.app](https://roast-u.vercel.app)
- **Watch on YouTube**: [Watch the Full Build Video](https://youtu.be/KBRR1OdD-ik)
Made with ❤️ by Jackson Kasi