GitHub Contributions API

A simple REST API service that provides detailed GitHub user contribution data using Server-Sent Events (SSE) for real-time streaming.

Features

• Stream user contributions (commits, issues, pull requests, pull request reviews, comments)
• Real-time data streaming via SSE
• Swagger/OpenAPI documentation
• TypeScript with full type safety

Installation

Download the repository with git clone:

git clone https://github.com/stergion/github-api-service.git

or curl

curl -L -O https://github.com/stergion/github-api-service/archive/main.zip

Navigate to the project directory

cd github-api-service

Install dependencies

npm install

Configuration

Create a .env file:

GITHUB_TOKEN=your_github_personal_access_token

Usage

Build the project:

npm run build

Start the server:

npm run start

The API will be available at http://localhost:3000

API Documentation

Access the Swagger UI at http://localhost:3000/api-docs