Github User and Repositories list

Software created to fetch and display github user information. The software has two states, one that displays the top 10 most accessed profiles and a second state that shows the profile in which the search was made. Project developed only with React, Typescript and Styled Somponents.

How to use

• Clone the project
• Install the project
• Change api key in .env file
• Run the project
• Be happy

Cloning the project

git clone https://github.com/glh-henrique/list-user.git
cd list-user

Configuration

First of all, you need to configure a Gitbub "API Key" to have access to the information. How to get this API Key? Simple!! Folow these steps, After that you need to put your api key in the .env file in the field REACT_APP_GITHUB_TOKEN and that's it! :D

Installation and Run the Project

This project requires Node.js v15+ to run. Install the dependencies and devDependencies and start the server.

yarn
yarn start

To run tests:

yarn run test

to build

yarn run build

License

MIT

Free Software, Hell Yeah!