Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/simonsmith/github-user-search

Browse GitHub users with React
https://github.com/simonsmith/github-user-search

aphrodite axios lodash-fp react redux redux-saga suit-css webpack

Last synced: 10 days ago
JSON representation

Browse GitHub users with React

Awesome Lists containing this project

README

        

# Github User Search [![Build Status](https://travis-ci.org/simonsmith/github-user-search.svg?branch=master)](https://travis-ci.org/simonsmith/github-user-search)

Search and view users via the Github API - https://simonsmith.github.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
1. Install dependences `yarn`
1. Run the server `yarnpkg run start`
1. 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](https://github.com/blog/1509-personal-api-tokens) and this will be
sent along in any API calls to increase the limit:

```
export USER_SEARCH_OAUTH=
yarnpkg run start
```

## TODO

* Service worker
* webpack chunks based on route