heziofernandes / github-user-search-v1

Github User Search

Introduction

This is a basic project that search for a user on github and then returns a few of the user data and it's repositories's names and descriptions.

Table of Contents:

Running the Tests

Test Report

Demo

How to get up and running

Clone or download the repo

• yarn to install dependencies
• yarn dev to run the project in development mode

How to commit into this repo?

• git commit since this repo uses husky and cli commitlint, a frindly cli will appear to help you commit a clear message

How to run the tests

Unit and integration testing (Jest and RTL)

After installing the dependencies (yarn install)

• yarn test to run all unit and integration tests

Test E2E with Cypress

• yarn dev to run the project in development mode
• yarn cy:open to run tests in Launchpad mode
  • Choose a testing type
  • Launch a browser
• yarn cy:test to run tests in CLI mode

Test Report

• In CLI mode, run: yarn cy:run a new report will be generated after running the tests.
• Access the file at: cypress/reports/html/index.html
• Open this file in the browser

Disclaimer

The github api is public and it has a limit of 60 request for a unauthenticated user

github-user-search-v1's Issues

Hitting enter key after entering the user does not perform the search

Description:
After entering the user's name in the search input and clicking enter, the search is not carried out, it is necessary to click on the search button for the search to be completed, this gives the application a usability deficit

Scenario:
Open the application
Enter a term in the search field
Click enter on the keyboard

Expected:
Search completed successfully

Actual:
You must click on the search button after entering the search term.

Missing 404 implementation/ feedback to user

Description:
Routes that do not exist in the application do not return adequate feedback to the user via the UI or API response.

Scenario:
Open the application
Enter a ' <script>alert('Testing')</script>' in the search field
Click on the search button

Expected:
Message, Page does not exist, in API 404.

Actual:
Nothing is displayed

Call is duplicated to Api /users

Description:
After searching for a user, the get User/Repo API is called twice, in the long term we would have a performance problem making several unnecessary requests and degrading the response time and resources of the service.

Scenario:

1. Open the application
2. Open the network option in DevTools
3. Search with a valid user

Expected:
The API call is made successfully once

Actual:
The call is made twice to /user and /user/repos

Returns repository with incorrect layout

Description:
When searching for a specific user, the user's repository name is displayed misaligned within the page layout

Scenario:
Open the application
Type 'joaotest' in the search field
Click on the search button

Expected:
The repositories are displayed misaligned

Actual:
The name and repository are displayed correctly aligned within the page layout.

Returns user without name after search

Description:
When searching for a specific user, the user's name is not displayed, and it is noted that the name attribute in the response body has a null value.

Scenario:
Open the application
Type 'jonastest' in the search field
Click on the search button

Expected:
The username and repositories are displayed

Current:
The user name is not displayed, only the name of the repositories.