Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sachin-chaurasiya/github-user-contribution-summary
A library with utilities to get the GitHub user contribution summary by username.
https://github.com/sachin-chaurasiya/github-user-contribution-summary
github github-con javascript npm npm-package typescript
Last synced: 2 months ago
JSON representation
A library with utilities to get the GitHub user contribution summary by username.
- Host: GitHub
- URL: https://github.com/sachin-chaurasiya/github-user-contribution-summary
- Owner: Sachin-chaurasiya
- License: mit
- Created: 2022-12-31T10:58:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-15T18:21:19.000Z (8 months ago)
- Last Synced: 2024-10-11T13:17:51.710Z (3 months ago)
- Topics: github, github-con, javascript, npm, npm-package, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/github-user-contribution-summary
- Size: 43.9 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: license
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Github User Contribution Summary
A library with utilities to get the GitHub user contribution summary by username.
View Demo
·
Report Bug
·
Request Feature
> To get your personal access token you can refer this guide [creating-a-personal-access-token](https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token)
## Installation
```bash
npm install github-user-contribution-summary
#OR
yarn add github-user-contribution-summary
```
## Usage
### With ES6
#### ContributionSummary
```js
import { getContributionSummary } from 'github-user-contribution-summary';
const getUserContributionSummary = async () => {
const argument = {
userName: 'Sachin-chaurasiya',
githubToken: '',
};
try {
const response = await getContributionSummary(
argument
);
console.log(response);
} catch (error) {
console.log('Something went wrong', error);
}
};
getUserContributionSummary();
// Output
{
"totalContributionCount": 3287,
"contributionByDate": [
{
"contributionCount": 5,
"date": "2022-11-18"
},
...
],
"totalPullRequests": 705,
"totalIssues": 316,
"totalStarredRepositories": 171,
"totalRepositoriesContributedTo": 31,
"totalRepositories": 60,
"totalGists": 3,
"totalFollowers": 63,
"totalPullRequestReviewed": 604
}
```
#### Pull Request Count
```js
import { getPullRequestCountByState } from 'github-user-contribution-summary'
const getPullRequestCount = async () => {
try {
const data = await getPullRequestCountByState(
{
userName: 'Sachin-chaurasiya',
githubToken: '',
},
'MERGED'
);
console.log(data);
} catch (error) {
console.log('error', error);
}
};
getPullRequestCount();
// Output
{ state: 'MERGED', count: 671 }
```
#### Issue Count
```js
import { getIssueCountByState } from 'github-user-contribution-summary'
const getIssueCount = async () => {
try {
const data = await getIssueCountByState(
{
userName: 'Sachin-chaurasiya',
githubToken: '',
},
'CLOSED'
);
console.log(data);
} catch (error) {
console.log('error', error);
}
};
getIssueCount();
// Output
{ state: 'CLOSED', count: 301 }
```
### With CommonJs
#### ContributionSummary
```js
const { getContributionSummary } = require('github-user-contribution-summary');
const getUserContributionSummary = async () => {
const argument = {
userName: 'Sachin-chaurasiya',
githubToken: '',
};
try {
const response = await getContributionSummary(
argument
);
console.log(response);
} catch (error) {
console.log('Something went wrong', error);
}
};
getUserContributionSummary();
// Output
{
"totalContributionCount": 3287,
"contributionByDate": [
{
"contributionCount": 5,
"date": "2022-11-18"
},
...
],
"totalPullRequests": 705,
"totalIssues": 316,
"totalStarredRepositories": 171,
"totalRepositoriesContributedTo": 31,
"totalRepositories": 60,
"totalGists": 3,
"totalFollowers": 63,
"totalPullRequestReviewed": 604
}
```
## How to Set up `github-user-contribution-summary` for Development?
Before starting, please check the [Contribution Guide](./CONTRIBUTING.md) to get started.
### Fork and Clone the Repo
First, you need to fork the `github-user-contribution-summary` repo. You can do this by clicking the `Fork` button on the top right corner of the repo. If you are new to forking, please watch this [YouTube Guide](https://www.youtube.com/watch?v=h8suY-Osn8Q) to get started.
Once forked, you can clone the repo by clicking the `Clone or Download` button on the top right corner of the forked repo.
Please change the directory after cloning the repository using the `cd ` command.
### Install Dependencies
Next, install the dependencies by running the following command in the `github-user-contribution-summary` repo:
```bash
npm install
```
Or
```bash
yarn install
```
### Build the package
Use the following command to build the package:
```bash
npm run build
```
Or
```bash
yarn build
```
It builds the package for production to the `lib` folder.
## Contributors
We value all contributions, no matter their size! To get started, please refer to our [CONTRIBUTING](./CONTRIBUTING.md) guide, and don't hesitate to reach out to us for any assistance you may need.
If you don't want to miss any updates, please show your support by giving the project a ⭐ 🚀.
We extend a massive THANK YOU to all our supporters!
[](https://github.com/Sachin-chaurasiya/github-user-contribution-summary/stargazers)