Skip to content

aftab-s/gitwrap-2025

Repository files navigation

GitWrap 2025 Banner

Showcase your 2025 GitHub contributions with a polished, customizable year-in-review card - themeable, concise, and ready to share.

GitWrap 2025

Create a polished year-in-review card for your GitHub contributions and share it with your network.

Live : https://gitwrap-2025.vercel.app

✨ Highlights

  • Personalized Stats: Commits, PRs, Issues, and Reviews aggregated into one card.
  • Multiple Themes: Choose from several visually appealing layouts and color schemes.
  • Shareable Export: Export your card as an image for LinkedIn, Twitter, or personal sites.
  • Fast & Lightweight: Built with Vite + React and TypeScript for snappy UX.
  • AI (Text Only): Uses Gemini API for text generation.

🚀 Quick Start (Development)

These steps get you running locally for development and testing.

Prerequisites

  • Node.js (v18+ recommended)
  • npm or yarn

Install & Run

  1. Clone the repo:
git clone https://github.com/aftab-s/gitwrap-2025.git
cd gitwrap-2025
  1. Install dependencies:
npm install
  1. Add environment variables by creating a .env.local file in the project root:
VITE_GEMINI_API_KEY=your_google_gemini_api_key
VITE_GITHUB_APP_TOKEN=your_github_personal_access_token
  1. Run the dev server:
npm run dev

The development server runs on http://localhost:3000 — open that URL after starting the server.

🧩 Project Structure (Top-level)

  • src/ — React components and app logic
  • public/images/ — banner and imagery used in the README and app
  • api/ — serverless endpoints

🎯 Tips for a Great Card

  • Try different themes in the app to find the best contrast for sharing on social.
  • Use the Export option to download a image.

🤝 Contributing

Contributions are welcome. Open an issue for discussion or submit a PR with your changes.

Short checklist for PRs:

  • Update or add tests if applicable
  • Keep changes focused and documented

🙏 Credits

Built by the GitWrap contributors. Hosted on Vercel: https://gitwrap-2025.vercel.app

👥 Contributors

This project is built and maintained by our amazing contributors. Thank you for your contributions!

Contributors

Happy wrapping! 🎁

About

GitHub year-in-review app that generates beautiful social cards for 2025 activity.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •