https://github.com/mauricioromagnollo/nodejs-github-api

An Github API integration developed with Node.js and TypeScript.
https://github.com/mauricioromagnollo/nodejs-github-api

github-api github-rest-api jest js-yaml nodejs

Last synced: 28 days ago
JSON representation

An Github API integration developed with Node.js and TypeScript.

• Host: GitHub
• URL: https://github.com/mauricioromagnollo/nodejs-github-api
• Owner: mauricioromagnollo
• License: mit
• Created: 2023-09-04T20:23:54.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2023-09-30T02:38:00.000Z (about 1 year ago)
• Last Synced: 2023-09-30T04:58:30.177Z (about 1 year ago)
• Topics: github-api, github-rest-api, jest, js-yaml, nodejs
• Language: TypeScript
• Homepage:
• Size: 49.8 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# nodejs-github-api

An [Github API](https://docs.github.com/pt/rest?apiVersion=2022-11-28) integration developed with Node.js and TypeScript.

> This code was a conversion from Python to JavaScript, from the original repository [https://github.com/ambrisolla/github-wrapper](https://github.com/ambrisolla/github-wrapper/tree/main).

## **Techs**

- [node.js](https://nodejs.org/en) - v18.17.1

- [typescript](https://www.typescriptlang.org/docs/)

- [jest](https://jestjs.io/pt-BR/docs/getting-started)

- [js-yaml](https://github.com/nodeca/js-yaml)

- [tsx](https://github.com/esbuild-kit/tsx)

- [dotenv](https://github.com/motdotla/dotenv)

## **Usage**

Install [Node.js](https://nodejs.org/en) in version **18.17.1** then install package dependencies:

```sh

npm ci

```

Create your `.env` file and set the variables:

```sh

cp `.env.example` `.env`

```

- `GITHUB_TOKEN` → Your Github Token;

- `REPOSITORY_NAME` → The name of the repository you want to test; 

- `ORG_OR_USER`→ The Github Organization name or your user name;

- `QUERY` → The query with the word you want to search for repositories that include it in the name;

## **Commands/Scripts**

Run [main.ts](./src/main.ts) file

```sh

npm run dev

```

Run [main.ts](./src/main.ts) file in watch mode

```sh

npm run dev:watch

```

Run tests with coverage

```sh

npm run test

```

Run test in watch mode

```sh

npm run test:watch

```