JavaScript CSS
Clone or download
Latest commit 83d533a Oct 4, 2017
ambar authored and ctrlplusb committed Oct 4, 2017 put meta[charset] before title (#497)

README.md

React, Universally

A starter kit for universal react applications.

All Contributors

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).

NOTICE: Please read this important issue about the behaviour of this project when using react-async-component, which is by default bundled with it.

Features

  • 👀 react as the view.
  • 🔀 react-router v4 as the router.
  • 🚄 express server.
  • 🎭 jest as the test framework.
  • 💄 Combines prettier and Airbnb's ESlint configuration - performing code formatting on commit. Stop worrying about code style consistency.
  • 🖌 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 react-async-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 v3.
  • 🚀 Full ES2017+ support - use the exact same JS syntax across the entire project. 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. Also has support for environment specific configuration files.
  • 🔥 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.
  • ❤️ 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
npm install
npm run develop

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

Docs

Who's using it and where?

You can see who is using it and how in the comments here. Feel free to add to that telling us how you are using it, we'd love to hear from you.

Contributors

Thanks goes to these wonderful people (emoji key):


Andrés Calabrese

💻

Andrey Luiz

💻

Alin Porumb

💻

Benjamin Kniffler

💻

Birkir Rafn Guðjónsson

💬 🐛 💻 👀

Carson Perrotti

💬 💻 📖 👀

Christian Glombek

🐛 💻

Christoph Werner

💬 🐛 💻 👀

David Edmondson

💻

Dion Dirza

💬 🐛 💻 📖 👀

Evgeny Boxer

🐛 💻

Joe Kohlmann

🐛 💻

Lucian Lature

🐛 💻 👀

Mark Shlick

💻

Ryan Lindskog

💻

Steven Enten

💬 🐛 💻 👀

Sean Matheson

💬 🐛 💻 📖 💡 👀 ⚠️ 🔧

Steven Truesdell

💬 🐛 💻 📖 ⚠️

Thomas Leitgeb

🐛 💻

Tyler Nieman

💻

This project follows the all-contributors specification. Contributions of any kind welcome!