JohnOliver23 / Github-Challenge

Repositório criado para o desafio da Dock que consiste em criar uma interface que possibilite um usuário fazer uma pesquisa por username e retornar informações básicas, assim como uma lista repositórios como no Github referentes a esse username.

Github-Challenge

This is a test for a Front-End Engineer position at Docker. The test consists of creating an interface that allows a user to do a search by username and return basic information, as well as a list of repositories as in Github referring to that username.

Publish domain

https://dock-challenge.herokuapp.com/

obs. before running the project, if you not have github personal access token, it's necessary to generate a personal access token in the github

Generate Personal Access Code

1. access your github profile
2. go to settings
3. go to Developer Settings
4. go to Personal access token
5. click in Generate new token
6. create the name token with any expiration date
7. select all scopes
8. generate and copy the token

Run the project

1. git clone https://github.com/JohnOliver23/Github-Challenge.git
2. cd Github-Challenge/
3. yarn install
4. open the file .env (if you are in linux environment, you can open with the comand : gedit .env)
5. change the line that contains REACT_APP_GITHUB_TOKEN=xxxxx-xxxxx-xxxxxx-xxxx for REACT_APP_GITHUB_TOKEN=your personal access token
6. yarn start

Run the tests

1. cd Github-Challenge/
2. yarn test

Run the tests report

1. yarn test:coverage

Pages

Home, Without Username Searched

• User can search repositories filtering by username
• the screen without username searched

Desktop

Mobile

Home, With Username Searched

• User can search repositories filtering by username
• the screen with username searched

Desktop

Mobile

Technologies:

• Typescript
• HTML
• CSS
• GraphQL

React FC with hooks

• useState for state control
• useMemo to memorize calculated values

Libraries

• Styled components
• SASS
• Axios
• React Router DOM
• React-Icons