Search Github Repos

Design

Design philosophy and components leverage Material UI

Getting Started

• Clone repository locally
• yarn install to install all dependencies
• Create .env file locally at root and add personal GitHub token
  • How to create personal access token
  • View sample.env as an example for the variable VITE_GITHUB_TOKEN
• yarn run dev to start the development server (vite)

Usage

• To search for a Users repositories append the desired Username to the URL, ie: http://localhost:8080/webpack
• The Home page displays the most popular repositories by selectable Language button
• Each User page displays an Avatar and a paginated list of repositories. Each is selectable and will link to the respective User/Repository when clicked
• Dark/Light theme is implemented with a toggle in the Header component. Desired setting is persisted to localStorage

Testing

Tests are leveraging Cypress for Component level testing

• Running component tests locally (headless)

  $ yarn run test-component

• View tests in Browser (select Component)

  $ yarn cypress open

Disclaimer

Current application does not utilize a proper backend server to handle external data fetching with authentication. For Production usage a dedicated backend should be leveraged.