# github-ratings

> A JavaScript module for both NodeJS and the Browser, which can be used to obtain various information about users and repositories.

Latest version **0.1.0** (published 2021-06-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install github-ratings
pnpm add github-ratings
yarn add github-ratings
bun add github-ratings
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.0 |
| Published | 2021-06-26 |
| First published | 2021-06-26 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 17.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Stan Georgian |
| Maintainers | georgianstan |
| Keywords | github, github stats, github stars, github profile, github ratings |

## Links

- npm: https://www.npmjs.com/package/github-ratings
- Repository: https://github.com/GeorgianStan/github-ratings
- Homepage: https://github.com/GeorgianStan/github-ratings#readme
- Issues: https://github.com/GeorgianStan/github-ratings/issues
- npm.io page: https://npm.io/package/github-ratings

## Dependencies (1)

- [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.1

## Alternatives

- [lodash.startswith](https://npm.io/package/lodash.startswith.md) — 769.7K weekly downloads
- [@tarojs/service](https://npm.io/package/@tarojs/service.md) — 33.9K weekly downloads
- [io.extendreality.tilia.indicators.spatialtargets.unity](https://npm.io/package/io.extendreality.tilia.indicators.spatialtargets.unity.md) — 131 weekly downloads
- [@rtarojs/taro](https://npm.io/package/@rtarojs/taro.md) — 90 weekly downloads
- [node-branch-io](https://npm.io/package/node-branch-io.md) — 50 weekly downloads

## Recent versions

- 0.1.0 (latest) — 2021-06-26
- 0.0.1 — 2021-06-26

## README

# github-ratings

<div style='text-align:center'>
    <img src='https://img.shields.io/github/issues/GeorgianStan/github-ratings' alt='issues'>
    <img src='https://img.shields.io/github/forks/GeorgianStan/github-ratings' alt='forks'>
    <img src='https://img.shields.io/github/stars/GeorgianStan/github-ratings' alt='stars'>
    <img src='https://img.shields.io/github/license/GeorgianStan/github-ratings' alt='license'>
    <img src='https://img.shields.io/github/package-json/v/GeorgianStan/github-ratings?color=%237146f9&logo=javascript' alt='version'>
    <a href="https://david-dm.org/georgianstan/github-ratings" title="dependencies status"><img src="https://status.david-dm.org/gh/georgianstan/github-ratings.svg"/></a>
</div>

`github-ratings` is a module for both NodeJS and the Browser, which can be used to obtain various information about users and repositories.

## Installation

_This package is Typescript ready_

```bash
npm i github-ratings
```

## How to use it

### Browser

To use it browser, you need to use the code from `browser.js` file.

```html
<script src="path-to-local-library/browser.js"></script>
```

or via CDN

```html
<script src="https://unpkg.com/github-ratings@X.Y.Z/browser.js"></script>
```

Where `X.Y.Z` represents the library version.

In this scenario, the library will be bound to the global window object with the property `GithubRatings`.

`window.GithubRatings` or simple `GithubRatings` can be used to access the library.

If you have a toolchain available you can use an `import` statement.

```ts
import GithubRatings from 'github-ratings/browser';
```

```js
const GithubRatings = require('github-ratings/browser');
```

---

### Node

The library is a default export.

For `NodeJS` environment, just replace `browser` with `node`.

```ts
import GithubRatings from 'github-ratings/node';
```

_Because is a default export, here you can import it with what name you want._

## Methods <sub style='font-size:15px'>(1)</sub>

(1)

```typescript
async fetchUserInfo(username: string, fields: UserField[]): Promise<PartialRecord<UserField, any>>  {}
```

This method will return information about a given user, based on the fields provided.

`UserField` can be one of the following:

- `name` - full name of the user
- `bio`
- `avatar_url` - profile pic URL
- `company`
- `blog`
- `location`,
- `email`,
- `twitter_username`,
- `public_repos`, - number of public repositories
- `followers`, - number of followers
- `following`, - the number of people being followed by the user
- `created_at`, - date at which the accout was created
- `starts`, - the number of total stars from the public repositories

_Example_

```js
const res = await GithubRatings.fetchUserInfo('GeorgianStan', [
  'stars',
  'public_repos',
  'created_at',
]);

// res = { created_at: "2017-02-15T14:54:15Z", public_repos: 37, stars: 50}
```

## Stay in touch

Author - [Stan Georgian](https://twitter.com/GeorgianStan9)

Discussions - [Discussions Page](https://github.com/GeorgianStan/github-ratings/discussions)

## License

This project is licensed under the [MIT License](https://github.com/GeorgianStan/github-ratings/blob/master/LICENSE)

---
_Source: https://npm.io/package/github-ratings · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._