git-awards

Discover your ranking on GitHub

!Semantically Releasedsemantic-release-badgesemantic-release !Build Statusbuild-badgebuild !Code Coveragecoverage-badgecoverage !versionversion-badgepackage !downloadsdownloads-badgenpmtrends !Styled with Prettierprettier-badgeprettier !AirBnB style guideairbnb-style-badgeairbnb-style
!MIT Licenselicense-badgeLICENSE !PRs Welcomeprs-badgeprs !Commitizen friendlycommitizen-badgecommitizen !Code of Conductcoc-badgecoc
!Watch on GitHubgithub-watch-badgegithub-watch !Star on GitHubgithub-star-badgegithub-star !Tweettwitter-badgetwitter
JavaScript client for Git Awards (http://git-awards.com), discover you GitHub ranking

Installing / Getting Started

npm install git-awards // most likely, yarn instead

import { getUser, getRankForLanguage } from 'git-awards';
// Or with CommonJS:
// const { getUser, getRankForLanguage } = require('git-awards');

getUser('<your-username>')
  .then(user => getRankForLanguage('<your-language>', user))
  .then(console.log.bind(console));

For usage details see the documentation.

Developing

Built With

• Axios
• Ramda

Pre-requisites

Setting up Dev

Here's a brief intro about what a developer must do in order to start developing the project further:

git clone https://github.com/blackxored/git-awards
cd git-awards
yarn

Building

Build CommonJS modules, documentation and more, with:

yarn build

Versioning

We use SemVersemver for versioning. In addition, it's automatic via semantic-releasesemantic-release, and our commit conventioncommit-convention.
For the versions available, see the Releasesreleases on this repository.

Tests

yarn test

Style guide

We base our code style on AirBnB's style guideairbnb-style and we check with ESLinteslint and automatically format our code with Prettierprettier.

API Reference

See the API reference in the documentation.

License

This project is licensed under the MIT License - see the license file for details.

Acknowledgments

• Git Awards for providing such an awesome site.

Contributing

If you're interested in contributing to this project in any form, please read our Contribution Guidelinescontributing.

Code of Conduct

We've adopted a Code of Conduct that we expect project participants to adhere to. Please read the full textcoc so that you can understand what actions will and will not be tolerated.

Contributors

Thanks goes to these people (emoji keyemojis):
|
_{Adrian Perez}
💻 📖 🚇") ⚠️ |
_{vincent daubry}
🚇") | | :---: | :---: |
This project follows the all-contributorsall-contributors specification. Contributions of any kind welcome!