GitHub Roasted is a platform that uses AI to provide humorous and constructive analysis of users' GitHub profiles. This platform combines comedy with useful feedback to help users improve their GitHub presence.
- Frontend: Next.js 15.0.3
- Styling: Tailwind CSS
- AI Integration: Google Gemini AI
- State Management: Zustand
- Animation: Framer Motion
- Analytics: Google Analytics & Umami
- Layout (layout.tsx): Sets up basic application structure, fonts, and analytics
- Home Page (page.tsx): Main page with Background, Title, Form, and ResultRoasted components
- API Route (route.ts): Handles integration with GitHub API and Gemini AI
Create a .env file based on .env.example:
- API_KEY_GEMINI_AI=<your_gemini_ai_key>
- GITHUB_PERSONAL_TOKEN=<your_github_token>
- NEXT_PUBLIC_BASE_URL=<your_website_url>
- Fetches complete profile data from GitHub API
- Analyzes statistics such as:
- Followers/following ratio
- Number of repositories
- Contributions
- GitHub account age
- Uses Gemini AI to generate roasts that are:
- Humorous and entertaining
- Constructive
- Multi-language
- Enhanced with emojis and pop culture references
Provides 3 categories of suggestions:
- Repository quality improvement
- Collaboration and networking
- Personal branding on GitHub
npm run devServer will run at http://localhost:3000 with Turbopack
npm run build
npm run startPlatform uses:
- Google Analytics for visitor tracking
- Umami for more privacy-focused analytics
- Uses environment variables to store API keys
- GitHub Personal Token for GitHub API access
- Rate limiting on API endpoints
- Meta tags for SEO optimization
- Google site verification
- Sitemap generation
- Optimal descriptions and keywords
- Use latest Node.js version
- Ensure access to Gemini AI
- GitHub Personal Token requires scope for reading public profile data
- Application uses TypeScript for type safety
To contribute:
- Fork repository
- Create new branch
- Commit changes
- Push to branch
- Create Pull Request
Developed by Yusup Supriyadi