Browse GitHub users with React
Switch branches/tags
Clone or download

README.md

Github User Search Build Status

Search and view users via the Github API - https://simonsmith.io/github-user-search

Requests are cached in session storage to limit the use of the API.

What is this?

A personal project built with React, Redux and other tools to search users and view their profiles on Github. Nothing serious.

Feel free to open issues for questions/improvements!

Libraries and tools

  • Aphrodite
  • Babel
  • Jest
  • React
  • React Router
  • Redux
  • Redux saga
  • SUIT CSS
  • Webpack
  • lodash-fp
  • normalizr

Running locally

  1. Clone the repository
  2. Install dependences yarn
  3. Run the server yarnpkg run start
  4. Visit http://localhost:3001/github-user-search/ (note the trailing slash)

API limit

The Github API has a fairly strict limit (hence the indicator of your remaining requests in the footer). When running the app locally you can export a personal access token and this will be sent along in any API calls to increase the limit:

export USER_SEARCH_OAUTH=<your token>
yarnpkg run start

TODO

  • Service worker
  • webpack chunks based on route