abiru / universal-react

A universal react starter, with routing, meta, title, and data features

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Universal React

This boilerplate aims at solving the MVP (Minimal Viable Product) of a universal app without making extraneous decisions for you (e.g. flux, layouts, testing, linting). The aim is to keep the codebase simple and readable for you to extend.

## Features

  • Universal routing (react-router)
  • Hot reloading
  • Title and meta, overridable by route components
  • Universal data fetching/rehydration on the client (isomorphic-fetch)
  • No other templating engines - React from root down
  • 404 and redirect handling

As you're more than likely to want to style your app you can also import scss (see App.js). It's easy to add css, less, or whatever you like using a webpack loader.

## Install & run

npm i && npm start

Go to http://localhost:3000/users to see isomorphic data fetching.

Adding routes

Add your routes in Routes.js.

<Route path='users' component={Users} onEnter={onRouteEnter} />

The onEnter callback is used to update the title on the client, otherwise it can be omitted.

Title and Meta

The parent App.js defines the fallback title and meta as static properties in the component:

static pageTitle = 'MyApp'

static meta = [{
	name: 'description',
	content: 'My super dooper dope app'
}]

However any route component can override these values (see Users.js). The properties can also be functions.

Data fetching and client hydration

If the route component needs to fetch data it should define a static requestState method which returns a Promise (or a Promise.all for multiple requests):

static requestState() {
	return fetch('http://jsonplaceholder.typicode.com/users')
		.then(function(response) {
			if (response.status >= 400) {
				throw new Error('Bad response from server');
			}
			return response.json();
		});
}

If your component has a requestState method and it's the first route (pre-rendered by the server), then the data will already be available via context.getInitialData(this) (or this.context outside the constructor), e.g:

constructor(props, context) {
	super(props, context);

	if (!context.getInitialData(this)) {
		Users.requestState().then(users => {
			this.setState({ users: users });
		});
	}

	this.state = {
		users: context.getInitialData(this)
	}
}

This ensures the server and client renders are isomorphic.

About

A universal react starter, with routing, meta, title, and data features


Languages

Language:JavaScript 99.7%Language:CSS 0.3%