/react-universally

A starter kit giving you the minimum requirements for a modern universal React application.

Primary LanguageJavaScriptMIT LicenseMIT

PUBLIC ANNOUNCEMENT 😀

v13 is going to land fairly soonish via the next branch. It includes a significant amount of updates and restructuring that would make a merged upgrade from v12 painful. If you want to stay up to date with the project you may want to consider using the next branch directly rather than master. The last big outstanding issue for v13 is issue #359.

React, Universally

A starter kit giving you the minimum requirements for a modern universal React application.

About

This starter kit contains all the build tooling and configuration you need to kick off your next universal React project, whilst containing a minimal "project" set up allowing you to make your own architecture decisions (Redux/MobX etc).

Features

  • 👀 react as the view.
  • 🔀 react-router v4 as the router.
  • 🚄 express server.
  • 🎭 jest as the test framework.
  • 🖌 Very basic CSS support - it's up to you to extend it with CSS Modules etc.
  • ✂️ Code splitting - easily define code split points in your source using code-split-component.
  • 🌍 Server Side Rendering.
  • 😎 Progressive Web Application ready, with offline support, via a Service Worker.
  • 🐘 Long term browser caching of assets with automated cache invalidation.
  • 📦 All source is bundled using Webpack v2.
  • 🚀 Full ES2017+ support - use the exact same JS syntax across the entire project (src/tools/config). No more folder context switching! We also only use syntax that is stage-3 or later in the TC39 process.
  • 🔧 Centralised application configuration with helpers to avoid boilerplate in your code.
  • 🔥 Extreme live development - hot reloading of ALL changes to client/server source, with auto development server restarts when your application configuration changes. All this with a high level of error tolerance and verbose logging to the console.
  • ⛑ SEO friendly - react-helmet provides control of the page title/meta/styles/scripts from within your components.
  • 🤖 Optimised Webpack builds via HappyPack and an auto generated Vendor DLL for smooth development experiences.
  • 🍃 Tree-shaking, courtesy of Webpack.
  • 👮 Security on the express server using helmet and hpp.
  • 🏜 Asset bundling support. e.g. images/fonts.
  • 🎛 Preconfigured to support development and optimised production builds.
  • 👼 Airbnb's ESlint configuration.
  • ❤️ Preconfigured to deploy to now with a single command.

Redux/MobX, data persistence, modern styling frameworks and all the other bells and whistles have been explicitly excluded from this starter kit. It's up to you to decide what technologies you would like to add to your own implementation based upon your own needs.

However, we now include a set of "feature branches", each implementing a technology on top of the clean master branch. This provides you with an example on how to integrate said technologies, or use the branches to merge in a configuration that meets your requirements. See the Feature Branches documentation for more.

Getting started

git clone https://github.com/ctrlplusb/react-universally my-project
cd my-project
yarn
yarn run development

Or, if you aren't using yarn:

git clone https://github.com/ctrlplusb/react-universally my-project
cd my-project
npm install
npm run development

Now go make some changes to the Home component to see the tooling in action.

Docs