https://github.com/chethanyadav456/github-api

A library for the GitHub API that fetches data from the API.
https://github.com/chethanyadav456/github-api

api github github-api hackertoberfest javascript nodejs

Last synced: about 2 months ago
JSON representation

A library for the GitHub API that fetches data from the API.

• Host: GitHub
• URL: https://github.com/chethanyadav456/github-api
• Owner: chethanyadav456
• License: mit
• Created: 2024-09-08T20:37:37.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-10-15T00:10:34.000Z (2 months ago)
• Last Synced: 2024-10-31T19:46:39.747Z (about 2 months ago)
• Topics: api, github, github-api, hackertoberfest, javascript, nodejs
• Language: JavaScript
• Homepage:
• Size: 19.5 KB
• Stars: 4
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.MD
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Github API

A library for the GitHub API that fetches data from the API.

[![DeepSource](https://app.deepsource.com/gh/chethanyadav456/Github-Api.svg/?label=code+coverage&show_trend=true&token=iQeRMNE2mbRs0Olsv46Z_gMj)](https://app.deepsource.com/gh/chethanyadav456/Github-Api/)

[![DeepSource](https://app.deepsource.com/gh/chethanyadav456/Github-Api.svg/?label=active+issues&show_trend=true&token=iQeRMNE2mbRs0Olsv46Z_gMj)](https://app.deepsource.com/gh/chethanyadav456/Github-Api/)

[![DeepSource](https://app.deepsource.com/gh/chethanyadav456/Github-Api.svg/?label=resolved+issues&show_trend=true&token=iQeRMNE2mbRs0Olsv46Z_gMj)](https://app.deepsource.com/gh/chethanyadav456/Github-Api/)

## Installation

To install this package, you can use the following command:

```bash

npm install @chethanyadav456/github-api

```

## Usage

To use this package, you can import it as follows:

```javascript

const GithubAPI = require('@chethanyadav456/github-api');

```

### Searching for user data

To search for user data, you can use the `getUser` method. This method takes a query string as an argument and returns an array of user objects. For example:

```javascript

const github = new GithubAPI();

github.getUser('chethanyadav456').then(data => {

  console.log(data);

});

```

### Searching for repositories

To search for repositories, you can use the `getRepos` method. This method takes a query string as an argument and returns an array of repository objects. For example:

```javascript

const github = new GithubAPI();

github.getRepos('chethanyadav456').then(data => {

  console.log(data);

});

```

## License

This project is licensed under the MIT license.

## Contributing

To contribute to this project, please follow the guidelines in the [CONTRIBUTING.md](CONTRIBUTING.md) file.

## Security Policy

To report a security vulnerability, please use the [Security Policy](SECURITY.md) file.

## Authors

- M Chethan Yadav