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

Node.js and npm/yarn
GitHub Personal Access Token (Classic)
- How to create a GitHub Personal Access Token
- Required permissions: public_repo, read:user, repo:status (if you need to include private repo commit status)

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

GITHUB_TOKEN=ghp_<your_token_here>

# Using yarn
yarn install

# Using npm
npm install

Run the development server:

# Using yarn
yarn dev

# Using npm
npm run dev

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

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

Open an Issue
- Found a bug? Have a feature request? Open an issue describing what you'd like to change.
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

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

Additional Next.js Resources