A beautiful, personalized year-in-review experience for your GitHub activity. Get insights into your coding journey with stunning visualizations, stats, and AI-generated highlights.
- 📊 Comprehensive Stats - Total commits, repositories, stars, and more
- 📈 Commit Activity Timeline - Visual representation of your coding patterns throughout the year
- 🎨 Top Languages - Beautiful chart showing your most-used programming languages
- 🏆 Top Repositories - Showcase your most popular and active projects
- 🤖 AI-Powered Highlights - Personalized achievements generated with Google Gemini AI
- 📸 Shareable Cards - Export your wrapped as a beautiful image for social media
- 🎭 Smooth Animations - Engaging user experience with Framer Motion
- 🌐 No Login Required - Works with public GitHub data only
- React 19 - UI library
- Vite - Build tool and dev server
- Tailwind CSS - Utility-first CSS framework
- Framer Motion - Animation library
- Chart.js - Data visualization
- React Router - Client-side routing
- Axios - HTTP client
- Lucide React - Icon library
- Node.js - Runtime environment
- Express.js - Web framework
- GraphQL - GitHub API queries
- Google Generative AI - AI-powered highlights
- CORS - Cross-origin resource sharing
- Node.js (v18 or higher)
- npm or yarn
- GitHub Personal Access Token
- Google Gemini API Key
- Clone the repository
git clone https://github.com/tolgab35/github-wrapped.git
cd github-wrapped- Install backend dependencies
cd backend
npm install- Install frontend dependencies
cd ../frontend
npm install- Configure environment variables
Create a .env file in the backend directory:
GITHUB_TOKEN=your_github_personal_access_token
GEMINI_API_KEY=your_google_gemini_api_key
PORT=3001To get your API keys:
- GitHub Token: Go to GitHub Settings → Developer Settings → Personal Access Tokens → Generate new token (classic)
- Required scopes:
read:user,repo(for public repositories)
- Required scopes:
- Gemini API: Visit Google AI Studio
- Start the backend server
cd backend
npm startThe server will run on http://localhost:3001
- Start the frontend development server
cd frontend
npm run devThe app will run on http://localhost:5173
- Open your browser and navigate to
http://localhost:5173
cd frontend
npm run buildThe production build will be in the dist folder.
The backend is ready for deployment as-is. Make sure to set environment variables on your hosting platform.
The project includes a vercel.json configuration for easy deployment:
cd frontend
vercel deployDeploy the backend to your preferred Node.js hosting platform and update the API URL in the frontend.
Contributions are welcome! Please feel free to submit a Pull Request.
- Fork the repository
- Create your feature branch (
git checkout -b feature/AmazingFeature) - Commit your changes (
git commit -m 'Add some AmazingFeature') - Push to the branch (
git push origin feature/AmazingFeature) - Open a Pull Request
This project is licensed under the MIT License - see the LICENSE file for details.
Tolga B.
- GitHub: @tolgab35
- GitHub API for providing comprehensive user data
- Google Gemini for AI-powered insights
- All the amazing open-source libraries used in this project
If you have any questions or run into issues, please open an issue on GitHub.
⭐ If you found this project helpful, please give it a star!
