Github Repository Tracker API

Description

A simple to use Github repository tracker API built using the powerful NestJS Framework

API Documentation

API Usage documentation is autogenerated using Swagger and can be viewed at http://localhost:3000/docs once the API has been started

Requirements

• Node 16 or higher

Installation

$ npm install

Running the app

# development
$ npm run start

# watch mode
$ npm run start:dev

# production mode
$ npm run start:prod

Test

# unit tests
$ npm run test

# e2e tests
$ npm run test:e2e

# test coverage
$ npm run test:cov

Authentication

This API accepts a GitHub fine-grained personal access token in order to authorize access to private repositories. This token, at a minimum, needs Read access to metadata and pull requests

Provide the token as an Authorization: Bearer {token} header to any API endpoint