react-apollo-koa-example

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

react-apollo-koa-example

★ 27 Open GitHub ↗

An example app using React, Apollo and Koa

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

react-apollo-koa-example
========================

An example web app using React, Apollo (GraphQL), Koa v.2.

This project was generated by [create-react-app](https://github.com/facebookincubator/create-react-app)
and is not [eject](https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-eject)ed.
Some settings are overwritten on runtime though.

[passport](https://github.com/yatsu/react-apollo-koa-example/tree/passport)
branch uses [Passport](http://passportjs.org/) to integrate authentication with
social services such as Google+, Facebook, etc., whereas `master` branch uses
[simple-oauth2](https://github.com/lelylan/simple-oauth2) to authenticate with
GitHub.

![screen image](https://raw.githubusercontent.com/yatsu/react-apollo-koa-example/master/docs/screen.png)

Setup
=====

Install [Node.js](https://nodejs.org/) and [Yarn](https://yarnpkg.com/).

Install required packages.

```sh
% yarn
```

Copy `.env.default` to `.env` and edit it to change server-side settings.

Copy `src/config-default.json` to `src/config.json` and edit it to change
client-side settings.

Usage
=====

Launch the API server:

```sh
% yarn run server
```

Launch the development web server which serves the static client-side files:

```sh
% yarn start
```

Open the URL (default: `http://localhost:3000`) in your browser.

Frameworks/Libraries
====================

### Client-side

* [React](https://facebook.github.io/react/)
* [Redux](http://redux.js.org/)
* [react-router](https://github.com/ReactTraining/react-router) and
  [react-router-redux](https://github.com/reactjs/react-router-redux)
  (URL routes management)
* [redux-auth-wrapper](https://github.com/mjrussell/redux-auth-wrapper)
  and [simple-oauth2](https://github.com/lelylan/simple-oauth2)
  (Authentication)
* [redux-logic](https://github.com/jeffbski/redux-logic)
  with [RxJS](https://github.com/ReactiveX/rxjs)
  (Async logic management)
* [react-app-rewired](https://github.com/timarney/react-app-rewired)
  (Customizing create-react-app w/o ejection)
* [Apollo](http://dev.apollodata.com/) (GraphQL)
* [Semantic-UI-React](http://react.semantic-ui.com/) (CSS framework)
* [React Storybook](https://github.com/storybooks/react-storybook) and
  [StoryShots](https://github.com/storybooks/storyshots) (UI dev and test)

The application code was generated by create-react-app.

See package.json for more information.

### Server-side (the API server)

* [Koa v.2](https://github.com/koajs/koa)
* [Apollo](http://dev.apollodata.com/) (GraphQL)

See package.json for more information.

The API server does not use DB and stores data on memory.
All changes will be cleared when you stop the server.

### Tests

* [Jest](https://facebook.github.io/jest/)
* [Nightmare](http://www.nightmarejs.org/) (Browser automation)

### Repo and code management

* [Husky](https://github.com/typicode/husky) and
  [lint-staged](https://github.com/okonet/lint-staged) (Git hooks)
* [ESLint](http://eslint.org/) with
  [eslint-config-airbnb](https://www.npmjs.com/package/eslint-config-airbnb)
  and our custom rules (JavaScript lint)
* [Flow](https://flow.org/) and
  [flow-typed](https://github.com/flowtype/flow-typed) (JavaScript type check)
* [prettier-eslint](https://github.com/prettier/prettier-eslint)
  (JavaScript format)
* [stylelint](https://github.com/stylelint/stylelint) with
  [stylelint-config-standard](https://github.com/stylelint/stylelint-config-standard)
  (CSS lint)
* [stylefmt](https://github.com/morishitter/stylefmt) (CSS format)

GraphQL/Apollo
==============

Persisted Queries
-----------------

GraphQL querires, mutations and subscriptions are defined in `src/graphql` as `.graphql` files.
They can be used as persisted queries.

You can enable persisted queries by modifying `config.json`.

```json
{
    "persistedQueries": true
}
```

You need to generate `extracted_queries.json` by executing this.

```sh
% yarn run persistgraphql
```

Read the following article to know about persisted queries.

* [Persisted GraphQL Queries with Apollo Client](https://dev-blog.apollodata.com/persisted-graphql-queries-with-apollo-client-119fd7e6bba5#.wnzn2qlpf)

Subscriptions
-------------

This example project uses subscriptions.
Select "GraphQL Subscription" tab in the header to see it.

Read the following article to know about subscriptions.

* [A proposal for GraphQL subscriptions](https://dev-blog.apollodata.com/a-proposal-for-graphql-subscriptions-1d89b1934c18#.vso7t15e5)

Authentication
==============

[JWT](https://tools.ietf.org/html/rfc7519 ) access token and refresh token are
used to authenticate a client.

* Access token
  * Expires in 2 hours (default)
* Refresh token
  * Expires in 60 days (default)
  * It is used only for refreshing the access token

The access token is automatically refreshed by
[WebClient](https://github.com/yatsu/react-apollo-koa-example/blob/master/src/WebClient.js)
and Apollo client (including GraphQL subscription).

When the refresh token is expired, the user will be automatically signed out.

The WebSocket connection will also be authenticated with a JWT access token.
It will be reconnected on signing in/out to do the authentication.
There are two types of connection, authenticated and unauthenticated.

You can set the expiration on server-side by editing `.env` file.

e.g.:

```sh
ACCESS_TOKEN_EXPIRES_IN=10s
REFRESH_TOKEN_EXPIRES_IN=2h
```

You need to sign out and sign in again to apply the new expiration.

It is also possible to set them in client-side localStorage if the server is
running on debugging mode.

Set `devHeaders` as the following (JSON encoded string):

```json
{ "X-ACCESS-TOKEN-EXPIRES-IN": "10s", "X-REFRESH-TOKEN-EXPIRES-IN": "2h" }
```

Setting `devHeaders` is useful for testing.
See [auth_token_test.js](https://github.com/yatsu/react-apollo-koa-example/blob/master/src/test/auth_token.test.js).

Storybook
=========

This project uses [React Storybook](https://github.com/storybooks/react-storybook).
to develop and check presentational components.

Launch the Storybook server:

```sh
% yarn run storybook
```

[StoryShots](https://github.com/storybooks/storyshots) is also used to enable
snapshot tests.
When you modify a component and the render result is changed, Jest reports an
error. If the shown result is intended, press `u` to update the snapshot file.

Code Organization
=================

Redux actions, reducers and logic are managed by
[Ducks](https://github.com/erikras/ducks-modular-redux) rules in `src/ducks`
directory.

Tests are stored in `__tests__` directories under each component.

Git Hooks
=========

Git hooks are managed by [Husky](https://github.com/typicode/husky).
When you run `yarn` in this repo, Git hooks will be automatically created.

If you have a problem, you can create them manually.

```sh
% node node_modules/husky/bin/install.js
```

Our Git hooks are defined in `package.json`.

react-apollo-koa-example

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README