Skip to content

Latest commit

 

History

History
50 lines (29 loc) · 1004 Bytes

File metadata and controls

50 lines (29 loc) · 1004 Bytes

github_assignment

An app that will help recruiters review candidates github information by listing the github repositories and maintain user information in database.

Prerequisite

1). Local mongodb instance 2). Node JS

Working

The app takes username and reponame as request and contains 2 controllers -

User-

EndPoint -

user/userSearch

This displays the user's details according to the github's username.

Repository -

EndPoint - repo/repoSearch

This API fetches the repositories with the supplied repository names. After the successful fetch of result repo name, owner name, description, stars count, and hyperlink to the repo URL are sent in the response output.

Installation npm install

Running the app

Development

Coommand for running in Development Mode -

$ npm run start

watch mode

Command for running in Watch Mode -

$ npm run start:dev

nodemon can also be used to run the app.

Postman

APIs can be accessed using this URL http://localhost:3000/