Github-API-Proxy

The API will Search all client requests to the appropriate GitHub endpoint.

and will return determinates infors about the users, user details and user repositories.

🚀Installation

To run the repositorie it's necessary clone the same.

$ git clone https://github.com/Marcos-OLiveiraVO/Github-API-Proxy.git

And use the following command to install the dependencies:

$ yarn 

Or

$ npm install 

✔ Running the App

Will run the app locallly on port : 3000

$ yarn dev

🏗️ Running the Build

will transpile the code typescript to javascript.

$ yarn build

🧪 Running the Tests

will execute the tests for the end-Points using jest.

$ yarn jest

🏴󠁵󠁭󠀹󠀵󠁿 Routes

All routes end-Points for consuming the api.

GET - /api/users?since={number} => return a list of GitHub users and the link for the next page.

GET - /api/users/:username/details  => return the details of a GitHub user.

GET - /api/users/:username/repos => return a list with all user repositories

You can use the insomnia app to do the request for the API end-points.

Or

You can Use the website API URL to make the request https://github-api-proxy-xnm7.onrender.com/api/users/

Here is an Example:

if you will test the api in the url I Recommend you use the extension called: JSON Beautifier & Editor.

🛠 Project was made using the following technologies and concepts:

- Node.
- Express.
- Typescript.
- jest.
- axios.