Skip to content

Latest commit

 

History

History
37 lines (28 loc) · 2.16 KB

README.md

File metadata and controls

37 lines (28 loc) · 2.16 KB
Raw

Github GraphQL

style: styled-components Build Status codecov

A first foray into using Github GraphQL API with React Apollo.

View the live app here:

https://martinbagshaw.github.io/Github-GraphQL/

please note that to use the live version of the app, you must login with your Github account details. This generates a temporary personal access token. See Todo

Screenshot 2020-10-27 at 22 52 03

To get running locally:

  • clone the repository
  • npm install
  • go to your github account and generate a personal access token
  • create an .env.local file in the root, with your access token in the following format:
    REACT_APP_TOKEN=your-token-here. Note that your token does not require quotes around it
  • npm start to view the app locally at http://localhost:3000/

Using this app:

If Viewing on Github Pages:

  • Enter your Github username and password to access the search engine, then...
  1. Search for a User's Details
  • a) Enter a valid github Username in the text input field
  • b) Press 'Submit' (with Get User's Details toggled)
  • c) Press 'Show More' to view more details
  1. Search for a User's Repositories
  • a) Toggle Get User's Repositories (with a valid username entered)
  • b) Use the filter buttons to see repositories the user has authored, forked, and contributed to
  • c) Press on a right arrow '>' from a repository to view more details about it
  • d) Press on a left arrow '<' to go back to the list of results