An open API service indexing awesome lists of open source software.

https://github.com/shreyas-sriram/gh-contributions-plus-plus

An application to re-create the GitHub contributions for multiple accounts.
https://github.com/shreyas-sriram/gh-contributions-plus-plus

aws-lambda github github-contributions github-readme-profile go-serverless golang lamdba serverless-framework

Last synced: 6 months ago
JSON representation

An application to re-create the GitHub contributions for multiple accounts.

Awesome Lists containing this project

README

          

[![Actions Status](https://github.com/shreyas-sriram/gh-contributions-plus-plus/workflows/CI/badge.svg)](https://github.com/shreyas-sriram/gh-contributions-plus-plus/actions)
# gh-contributions-plus-plus

A Golang application to aggregate the GitHub contributions of multiple accounts.

![gh-contributions](https://github.com/shreyas-sriram/gh-contributions-plus-plus/blob/pages/docs/images/page.png)

![dark-theme](https://github.com/shreyas-sriram/gh-contributions-plus-plus/blob/pages/docs/images/dark-theme.png)

![light-theme](https://github.com/shreyas-sriram/gh-contributions-plus-plus/blob/pages/docs/images/light-theme.png)

### GitHub Profile README Integration

This application can be deployed and used as follows in your GitHub profile README

```
![gh-contributions](https:///aggregate?username={username1}&username={username2}&year=2020&theme=dark)
```

### Usage

1. Start the server

- on host machine
```
make build.x && make server.start
```
> where 'x' is the runtime environment. Currently, `linux` and `mac` are available in the Make target.

- in docker
```
make docker
```

2. Open browser and browse to
```
localhost:3000/api/contributions?username={username}&username={username}&year={year}&theme={theme}
```

#### Options

```
username
description : list of usernames

year
description : year
default : current year

theme
description : theme
values :
default : light
```