shaw-partners

Its purpose is to consume the GitHub APIs, more precisely the user and repositories endpoints, and create an application.

challenge requirements

• API that will proxy all client requests to the appropriate GitHub endpoint.
• Create tests for your application covering all endpoints.

Environment variables

To run this project, you may need to create an .env file

PORT

Endpoints

• GET - /api/users?since={number}
• GET - /api/users/:username/details
• GET - /api/users/:username/repos

Running locally

Clone the project

  git clone https://github.com/samuelsankys/shaw-partners.git

To start the server

Be in the project directory

  cd shaw-partners

Install dependencies

  npm install

Init Server

  npm run dev

Or by docker-compose

Be in the project directory

  cd shaw-partners

Init docker-compose

  docker-compose up

Stack

Back-end: Node, Express

API: GitHub