https://github.com/igorprado/isomorphic-react-app
An isomorphic React app using isomorphic-flux-boilerplate
https://github.com/igorprado/isomorphic-react-app
Last synced: about 1 year ago
JSON representation
An isomorphic React app using isomorphic-flux-boilerplate
- Host: GitHub
- URL: https://github.com/igorprado/isomorphic-react-app
- Owner: igorprado
- Created: 2015-10-08T23:06:17.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2015-10-11T19:30:25.000Z (over 10 years ago)
- Last Synced: 2025-04-07T13:05:30.529Z (over 1 year ago)
- Language: JavaScript
- Homepage: https://isomorphic-react-app.herokuapp.com/
- Size: 727 KB
- Stars: 8
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://travis-ci.org/iam4x/isomorphic-flux-boilerplate)
[](https://coveralls.io/github/iam4x/isomorphic-flux-boilerplate?branch=master)
[](https://david-dm.org/iam4x/isomorphic-flux-boilerplate)
[](https://david-dm.org/iam4x/isomorphic-flux-boilerplate#info=devDependencies)
[](https://www.npmjs.com/package/isomorphic-flux-boilerplate)
# ES6 Isomorphic Flux/ReactJS Boilerplate
> A wonderfull boilerplate for **Flux/ReactJS** [isomorphic](http://nerds.airbnb.com/isomorphic-javascript-future-web-apps/) applications, running on **Koa**.
**Demo:** http://isomorphic.iam4x.fr
## Libraries Included
* [react](https://facebook.github.io/react/)
* [react-router](https://github.com/rackt/react-router)
* [react-intl](https://github.com/yahoo/react-intl)
* [react-redbox](https://github.com/KeywordBrain/redbox-react)
* [alt](https://github.com/goatslacker/alt)
* [iso](https://github.com/goatslacker/iso)
* [koa](http://koajs.com/)
* [webpack](http://webpack.github.io/)
* [webpack-hot-middleware](https://github.com/glenjamin/webpack-hot-middleware)
* [webpack-dev-middleware](https://github.com/webpack/webpack-dev-middleware)
* [babeljs](https://babeljs.io/)
* [cssnext](http://cssnext.io/)
## TL;DR
Use with `nodejs^4.x`, clone the repo, `npm install` and `npm run dev`.
Learn React ([react-prime-draft](https://github.com/mikechau/react-primer-draft)), learn Flux and Alt ([alt guide](http://alt.js.org/guide/)).
Wrap you async actions into promises, send them to `altResolver` with `altResolver.resolve(xxx)` for async server side rendering (see [app/actions/users.js:31](https://github.com/iam4x/isomorphic-flux-boilerplate/blob/master/app/actions/users.js#L31)).
Build for production with `npm run build`, don't forget to run the tests before `npm test`.
## Concepts
**Koa** will be our server for the server side rendering, we use **alt** for our Flux architecture and **react-router** for routing in our app.
With **iso** as helper we can populate **alt** flux stores before the first rendering and have a complete async isomorphic React application.
Run this boilerplate, you will see the server is fetching some fake users and will populate the `UserStore` with this data. **Koa** will render the first markup, serve the JavaScript and then it will entirely run on the client.
## Flux
We use [alt](http://alt.js.org) instance as [Flux](http://facebook.github.io/react/blog/2014/05/06/flux.html) implementation.
We need to use instances for isomorphic applications, to have a unique store/actions per requests on the server.
On the client, Flux is initialized in `app/main.js` and sent to our first React Component via props (`this.props.flux`). Everytime you want to uses stores or actions in a component you need to give it access through props.
On the server, it's similar but Flux is initialized in `server/router.jsx`. The instance is sent to `alt-resolver` for rendering components with the correct props.
Learn more about [alt instances](http://alt.js.org/docs/altInstances) in the alt documentation.
## Internationalization (i18n)
We use [react-intl](https://github.com/yahoo/react-intl) for internationalization, it uses browser implementation of [Intl](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl). For older browser and for node, we load the polyfill.
* Support localized strings (see [data/en.js](https://github.com/iam4x/isomorphic-flux-boilerplate/blob/master/app%2Fdata%2Fen.js))
* Support localized dates, times and currencies.
Lang files and Intl polyfill are compiled into webpack chunks, for lazy-loading depending the locale of the user.
If user changes locale, it is saved into a cookie `_lang` and used by the server to know the locale of rendering. If there's no `_lang` cookie, server will rely on `Accept-Language` request header. Server will set `` on rendering.
Thank's to [gpbl/react-locale-hot-switch](https://github.com/gpbl/react-locale-hot-switch) for the implementation example!
In order to use `FormattedRelative` you have to pass `{...this.props}` to component:
```
```
## Localized routes
We have an utility to generate severals routes for the same component (see `app/utils/localized-routes.js`).
Use the same logic as localized string, declare the localized routes into `app/routes.js` and into your `data/{lang}` file.
## Async data-fetching
Alt-resolver is the magic thing about the boilerplate, it will be our tool for resolving promises (data-fetching) before server side rendering.
Wrap data-fetching requests from actions into promises and send them to `altResolver` like:
```
fetch() {
const promise = (resolve) => {
request
.get('http://example.com/api/users')
.end((response) => {
// fire new action to send data to store
this.actions.fetchSuccess(response.body);
return resolve();
});
};
// Send the `promise` to altResolver
this.alt.resolve(promise);
}
```
Call the fetch action from component in the `componentWillMount` method:
```
static propTypes: {
flux: React.PropTypes.object.isRequired
}
componentWillMount() {
const usersActions = this.props.flux.getActions('users');
return usersActions.fetch();
}
```
On browser side, the rendering won't be stopped and will resolve the promise instantly.
On server side, `altResolver.render` will fire a first render to collect all the promises needed for a complete rendering. It will then resolve them, and try to re-render the application for a complete markup.
Open `app/actions/users.js`, `app/utils/alt-resolver.js`, `app/stores/users.js` for more information about data-fetching.
## How to `require()` images on server side
On client with webpack, you can directly `require()` images for your images DOM element like:
```
})
```
Webpack will load them through the `url-loader` and if it's too big it will sent through `file-loader` for minification/compilation. The results is an image with a new filename for cache busting.
But on node, `require()` an image will just throw an exception. There's an util for loading image on server side to achieve this:
```
import imageResolver from 'utils/image-resolver'
let image;
// On browser just require() the image as usual
if (process.env.BROWSER) {
image = require('images/logo.png');
}
else {
image = imageResolver('images/logo.png');
}
...
render () {
return (
);
}
...
```
The utils/image-resolver with match the original image name with the compiled one.
Voilà! You can `require()` images on server side too.
## Installation / How-to
It's super easy to do with [nvm](https://github.com/creationix/nvm):
* `$ nvm install stable`
* `$ nvm use stable`
* `$ nvm alias default stable`
After that, you will just need to clone the repo and install dependancies:
* `$ git clone -o upstream https://github.com/iam4x/isomorphic-flux-boilerplate.git app`
* `$ cd app && npm install`
(Don't forget to add your remote origin: `$ git remote origin git@github.com:xxx/xxx.git`)
### Run the project in development:
* `$ npm run dev`
Open your browser to `http://localhost:3002` and you will see the magic happens! Try to disable JavaScript in your browser, you will still be able to navigate between pages of the application. Enjoy the power of isomorphic applications!
(Note: ports 3000-3002 are needed, you can change this with `$ PORT=3050 npm run dev` it will run on 3050-3052)
### Run tests
* `$ npm test` will run the tests once
* `$ npm run dev-test` will watch for changes and run the tests on change
### Build project:
Just run `$ npm run build`, it will produce these tasks:
* Run tests from `test/spec/**/*.jsx`
* Concat & minify styles to `/dist/app-[hash].css`
* Concat & minify scripts to `/dist/js/app-[hash].js`
### Update the boilerplate
You can fetch the upstream branch and merge it into your master:
* `$ git checkout master`
* `$ git fetch upstream`
* `$ git merge upstream/master`
* `$ npm install`
### Run in production
Build the project first:
* `$ npm run build`
Then start the koa server:
* `$ NODE_ENV=production node server/index.js`
You can also use `processes.json` to run the application with [PM2 Monitor](https://github.com/Unitech/pm2) on your production server (customize it for your use):
* `$ pm2 start processes.json`
### (OSX) Run into docker for development
You can build and dev with the boilerplate through docker container, it runs with dinghy.
* Install [dinghy](https://github.com/codekitchen/dinghy) (it has support for NFS sharing which is required for changes detection and it's fast!)
* `$ docker-compose up && open http://webapp.docker`
### Learn more
* [Official ReactJS website](http://facebook.github.io/react/)
* [Official ReactJS wiki](https://github.com/facebook/react/wiki)
* [Official Flux website](http://facebook.github.io/flux/)
* [ReactJS Conf 2015 links](https://gist.github.com/yannickcr/148110d3ca658ad96c2b)
* [Learn ES6](https://babeljs.io/docs/learn-es6/)
* [ES6 Features](https://github.com/lukehoban/es6features#readme)