Github Gamification - Achievements system as a GitHub WebHook.
Clone or download
Latest commit 16aa683 Nov 13, 2018

README.md

WIP

achievibit Logo

semantic-release Build Status Coverage Status Codacy Badge

Description

  • Get achievements on different characteristics of your pull requests
  • Use the achievibit chrome extension 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 Chrome Store Downloads

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
[![Supported achievements](http://achievibit.kibibit.io/achievementsShield)](https://achievibit.kibibit.io)

Development

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# incremental rebuild (webpack)
$ npm run webpack
$ npm run start:hmr

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Stay in touch

Contributors

Want to file a bug, contribute some code, or improve documentation? Excellent! Read up on our guidelines for contributing.

You can check out some easy to start with issues in the Easy Pick.

Contributor Code of Conduct

Please note that this project is released with a Contributor Code of Conduct.

By participating in this project you agree to abide by its terms.

License

MIT License

Copyright (c) 2018 Neil Kalman <neilkalman@gmail.com>