Git Wrapped API

Git Wrapped is the API that powers git-wrapped.com (Github Wrapped), a service that generates beautiful visualizations of your GitHub activity.

🚀 Quick Start

Prerequisites

1. Node.js and npm/yarn
2. GitHub Personal Access Token (Classic)
   • How to create a GitHub Personal Access Token
   • Required permissions: public_repo, read:user

Environment Setup

Create a .env.local file in the root directory with:

GITHUB_TOKEN=ghp_<your_token_here>

Installation

# Using yarn
yarn install

# Using npm
npm install

Development

Run the development server:

# Using yarn
yarn dev

# Using npm
npm run dev

The application will be available at http://localhost:3000.

🛠 Technical Stack

• Next.js 13
• TypeScript
• Main API file: api/stats.ts

🤝 Contributing

We welcome contributions from the community! Here's how you can help:

1. Open an Issue

   • Found a bug? Have a feature request? Open an issue describing what you'd like to change.

2. Submit a Pull Request

   • Fork the repository
   • Create a new branch for your feature
   • Make your changes
   • Submit a PR with:
     • Clear description of the changes
     • Link to the related issue
     • Sample result/screenshot if applicable
   • Wait for review

📝 License

The code in this repository is licensed under the MIT License.

---

Additional Next.js Resources

• Next.js Documentation
• Learn Next.js
• Next.js GitHub Repository
• Next.js Deployment Documentation