GitHub Explorer

An application to explore GitHub repositories.

Click here to access the deployed application.

Preview

Features

Search Repositories page

• Search repositories
  • Auto search when the user is done typing
• Social authentication with Github to search private repositories
  • Sign in
  • Sign out
  • Show user name when signed in
• Save user repositories on the repository list and storage them on localStorage
  • Clear list
  • Remove items from the list
  • Pagination
• Toast to give feedbacks to user
  • Display information about the API timing responses
  • Use browsers navigator properties to display relative dates and times
  • Toast variants for success, error and info.

Repository page

• Repository details
• Repository README
• Repository issues list
  • Pagination

App

• Reponsive app
• Improve app accessibility
• Internationalization

Code Quality

• 100% unit and integration test coverage
• Cypress E2E tests

Running project locally

1. Clone this repository:

   git clone https://github.com/ygorthiago/github-explorer.git

   or

   git clone git@github.com:ygorthiago/github-explorer.git

2. Access the project folder on CLI and install dependencies:

   npm install

3. Run the "dev" script:

   npm run dev

   The project will start on port 3000 - access http://localhost:3000

⚠ To use the GitHub social authentication feature, it's necessary to have an application on Firebase and integrate it with Github OAuth. Then, just have to create a ".env" file in the project root and populate it based on ".env.example" file with your Firebase configuration data. In case of doubts, you can contact me here!

Running unit/integration tests

1. Run the "test" script:

   npm run test

Running E2E tests

1. Install Cypress Test Runner. You can install using this link.

2. Run the application locally running the "dev" script in the terminal:

    npm run dev

3. Run the "cypress:open" script in other terminal:

   npm run cypress:open