https://github.com/gh-conf/gh-api

Github api module used by gh-conf repositories
https://github.com/gh-conf/gh-api

api contributors forked-repo github github-api repository

Last synced: about 1 month ago
JSON representation

Github api module used by gh-conf repositories

• Host: GitHub
• URL: https://github.com/gh-conf/gh-api
• Owner: gh-conf
• License: mit
• Created: 2019-05-20T17:09:42.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2022-07-10T14:17:28.000Z (over 2 years ago)
• Last Synced: 2024-08-09T10:14:44.610Z (5 months ago)
• Topics: api, contributors, forked-repo, github, github-api, repository
• Language: JavaScript
• Size: 258 KB
• Stars: 1
• Watchers: 2
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# gh-api

[![Build](https://travis-ci.com/gh-conf/gh-api.svg?branch=master)](https://travis-ci.com/gh-conf/gh-api/)

Github api module, used by gh-conf repositories

## Install

```

npm install @gh-conf/gh-api

```

## Usage

```js

const { Contributors, ParentRepo } = require('@gh-conf/gh-api');

const username = 'arshadkazmi42';

const repository = 'strmat';

const forkedRepo = 'taskcluster';

// Fetches list of contributors of the repository

const contributors = await Contributors(username, respository);

// Output

/**

 [

  {

    'avatar_url': 'https://avatars3.githubusercontent.com/u/4654382?v=4',

    'contributions': 9,

    'events_url': 'https://api.github.com/users/arshadkazmi42/events{/privacy}',

    'followers_url': 'https://api.github.com/users/arshadkazmi42/followers',

    'following_url': 'https://api.github.com/users/arshadkazmi42/following{/other_user}',

    'gists_url': 'https://api.github.com/users/arshadkazmi42/gists{/gist_id}',

    'gravatar_id': '',

    'html_url': 'https://github.com/arshadkazmi42',

    'id': 4654382,

    'login': 'arshadkazmi42',

    'node_id': 'MDQ6VXNlcjQ2NTQzODI=',

    'organizations_url': 'https://api.github.com/users/arshadkazmi42/orgs',

    'received_events_url': 'https://api.github.com/users/arshadkazmi42/received_events',

    'repos_url': 'https://api.github.com/users/arshadkazmi42/repos',

    'site_admin': false,

    'starred_url': 'https://api.github.com/users/arshadkazmi42/starred{/owner}{/repo}',

    'subscriptions_url': 'https://api.github.com/users/arshadkazmi42/subscriptions',

    'type': 'User',

    'url': 'https://api.github.com/users/arshadkazmi42',

  }

];

**/

// Fetches upstream url of the repository from parent repository

const upstream = await ParentRepo(username, forkedRepo);

// Output

// https://github.com/taskcluster/taskcluster

```

## API

#### `contributors`

- Fetches list of all contibutors of the repository

- Input: username, repository

#### `parentRepo`

- Fetches parent repository url

- Input: username, repository

## Contributing

Interested in contributing to this project?

You can log any issues or suggestion related to this library [here](https://github.com/gh-conf/gh-api/issues/new).

Read our contributing [guide](CONTRIBUTING.md) to get started with contributing to the codebase.