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

https://github.com/kibibit/achievibit

Github Gamification - Achievements system as a GitHub WebHook.
https://github.com/kibibit/achievibit

achievements fun gamification shield webhook webhooks

Last synced: 11 months ago
JSON representation

Github Gamification - Achievements system as a GitHub WebHook.

Awesome Lists containing this project

README

          


achievibit Logo


@kibibit/achievibit









Server Unit Tests


Client Unit Tests


API Tests


E2E Tests






All Contributors



Github Gamification - Achievements system as a GitHub WebHook.



[![Production](https://img.shields.io/badge/Production-application-informational?logo=heroku)](https://achievibit.kibibit.io/) [![Production Docs](https://img.shields.io/badge/Production-api--docs-85EA2D?logo=swagger)](https://achievibit.kibibit.io/docs/)

[![Beta](https://img.shields.io/badge/Beta-application-informational?logo=heroku)](https://achievibit-beta.herokuapp.com/) [![Beta Docs](https://img.shields.io/badge/Beta-api--docs-85EA2D?logo=swagger)](https://achievibit-beta.herokuapp.com/api/docs)
## Description

- Get achievements on different characteristics of your pull requests
- Use the [achievibit chrome extension](https://chrome.google.com/webstore/detail/achievibit/iddkmddomdohnihbehiamfnmpomlhpee?utm_source=achievibitreadme) to see `achievibit` inside `GitHub`

## how to use

**we're working on implementing GitHub oAuth to support some extra features.**

***stay tuned***

`achievibit` needs to be integrated into each enabled repository via a **webhook**.

1. Go to your main repository page
2. click on ***Settings***
3. on the sidebar, click on ***Webhooks***
4. click on ***add webhook***
5. paste achievibit's url (`https://achievibit.kibibit.io`) into the ***payload url***
6. change ***Content type*** to `application/json`
7. on ***Which events would you like to trigger this webhook?***, select `Let me select individual events.` and check `Pull request` and `Pull request reviews`

**Maybe sometime later we'll also support repo achievements. open an issue if you're interested :-)**

## Chrome extension [![Chrome Store Version](https://img.shields.io/chrome-web-store/v/iddkmddomdohnihbehiamfnmpomlhpee.svg)](https://chrome.google.com/webstore/detail/achievibit/iddkmddomdohnihbehiamfnmpomlhpee) [![Chrome Store Downloads](https://img.shields.io/chrome-web-store/d/iddkmddomdohnihbehiamfnmpomlhpee.svg)](https://chrome.google.com/webstore/detail/achievibit/iddkmddomdohnihbehiamfnmpomlhpee)
You can install our chrome extension to see achievements in github profiles,
and see an animation everytime you get an achievement

## Add our shield to your project's README

We've just started, and we want to spread the word. We would really appreciate if you'll add our shield if you think `achievibit` is worth talking about

copy this snippet to any **markdown** file
- shield: number of achievable achievements [![Supported achievements](http://achievibit.kibibit.io/achievementsShield)](https://achievibit.kibibit.io)

```markdown
[![Supported achievements](http://achievibit.kibibit.io/achievementsShield)](https://achievibit.kibibit.io)
```

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):



Neil Kalman

💻 📖 🎨 🚧 🚇 ⚠️

O T

💻 ⚠️

Michael Dunaevsky

💻 ⚠️ 🐛

Andrea Rosales

🐛 💻

Daniel Ruf

🐛 📖

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!

## Stay in touch

- Author - [Neil Kalman](https://github.com/thatkookooguy)
- Website - [https://github.com/kibibit](https://github.com/kibibit)
- StackOverflow - [thatkookooguy](https://stackoverflow.com/users/1788884/thatkookooguy)
- Twitter - [@thatkookooguy](https://twitter.com/thatkookooguy)
- Twitter - [@kibibit_opensrc](https://twitter.com/kibibit_opensrc)