https://github.com/carter907/gitty-api

gitty-api is a set of functions that interface with the Github API at a high level.
https://github.com/carter907/gitty-api

api github-api

Last synced: 3 days ago
JSON representation

gitty-api is a set of functions that interface with the Github API at a high level.

• Host: GitHub
• URL: https://github.com/carter907/gitty-api
• Owner: Carter907
• License: mit
• Created: 2024-06-27T19:18:28.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-06-27T21:03:36.000Z (7 months ago)
• Last Synced: 2024-06-28T22:40:14.924Z (6 months ago)
• Topics: api, github-api
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/@carte_907/gitty-api
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
### Gitty API

gitty api is a set of functions that allows you to interface with your github repositories at a high level.

### API token

gitty api uses your api token to make requests. Please set an environment variable called `GH_API_TOKEN`

set to your token to successfully call these functions.

### Install

use npm to install this package

```

npm i @carte_907/gitty-api

```

### Usage

Get all of a user's repositories

```js

let projects = await getAllRepos('[user]')

```

Get Repositories with at least a certain number of forks

```js

let moreThan4Forks = await getReposWithForks('[user]', 5) // 5 or more forks

```

Get Repositories with at least a certain number of stars

```js

let popularRepositories = await getReposWithStarts('[user]', 1000) // 1000 or more stars

```