mauricioromagnollo / nodejs-github-api

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

nodejs-github-api

An Github API 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.

Techs

• node.js - v18.17.1
• typescript
• jest
• js-yaml
• tsx
• dotenv

Usage

Install Node.js in version 18.17.1 then install package dependencies:

npm ci

Create your .env file and set the variables:

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 file

npm run dev

Run main.ts file in watch mode

npm run dev:watch

Run tests with coverage

npm run test

Run test in watch mode

npm run test:watch