Readme.md

Budgeting :: A Modern React, Redux, React Router 4, Webpack Sample App

Production-ready React + Webpack architecture implemented on consumer web apps of some of the most successful enterprises in the world. Perceived performance and development experience are key factors in this setup. You can use this code base for learning or to scaffold your mission-critical project.

See live demo.

Budgeting Application

The is a simple budget management application. It tracks inflow and outflow, shows remaining budget, and interesting reports with charts. As such, it offers more features than the usual Todo App.

Budgeting app is a showcase project that demonstrates important decisions in architecture and development of a modern React application.

Feel free to use it as a reference app or a starter kit.

Key concepts:

• Webpack 3 Tree shaking
• PRPL pattern with minimal application core
• Automatic code splitting with React Router 4 and import() statement
• Automatic common chunk bundling
• CSS modules
• Snapshot testing with Jest
• Flow static typing. Check out this guide to using Flow in the project.
• Performance budgets in Webpack 3
• React 16 Error Boundaries

Performance

The app loads in 1 second on 3G, cache disabled

Budgeting app is blazing fast, thanks to the smart architecture and Webpack 3 configuration. It takes about 1000ms (1s) to load on 3G (see above).

Emerging Markets 3G Filmstrip

The aggressive test above shows the budgeting app loads in under 5 seconds. It's a heavily limited connection that accounts for poor connectivity and limited bandwidth.

All important (aka critical path) assets are loaded as early as possible, while the others (e.g. images or GitHub buttons) will load after the first render.

How did we get that performance?

1. Minimal application core. We decided to ditch the usual convention of creating a vendor chunk. Instead, it's bundled in the app core. The app core is actually very small, containing just the code needed to bootstrap the app.
2. Common code is a chunk. We let Webpack figure out which bundles we reuse in chunks and create a common chunk that's also asyncronous.
3. Redux module injection. Each chunk contains respective views and redux modules. Yes, that means reducers, action creators, actions - are all dynamically injected as we navigate through routes. That adds to the minimal application core concept and PRPL pattern.
4. H2 Push. The app is hosted on Firebase and we use the magic of HTTP2 Push to push some of the scripts before they are requested.
5. Pre-caching. Service Workers pre-cache resources so the browser can access them as soon as the user needs to.

Charts

Charts are developed using the awesome D3 library. The idea behind showing charts is not only to show beautiful content, but also to demonstrate keeping heavy content in a chunk that owns it. In other words - we show how applications can run fast even if they use larger libraries.

D3 is used in the /reports route only. Given that major routes are separate chunks (code splitting FTW!), the entire D3 library is bundled with the code that needs it. That makes the /reports route a bit heavier than the initial /budget route, but it also makes routes much faster to load.

Performance Budgets

We are looking to maintain the lightest possible application core (aka entry chunk). Our target is 300kB for the entrypoint and 300kB for all other assets. This is how we set it in webpack configuration:

performance: {
  maxAssetSize: 300000,
  maxEntrypointSize: 300000,
  hints: 'warning',
},

Adding lots of extra code to the entry chunk might cause the build (yarn run build) process to show a warning.

Simulated size warning

Note that running webpack dev server in production mode (yarn run prod) will trigger this warning because of the additional dev server code injected in the app. This code will not show in regular production builds.

Service Workers

Service workers are enabled only when serving static files, not through webpack-dev-server. Here's how you can test service worker functionality:

1. Run yarn run build (or npm run build) to build the app
2. Run yarn run serve (or npm run serve) to serve the app on localhost:3000
3. Run a new instance of Chrome with disabled security (because localhost is not on https):

OS X

open -a "Google Chrome" --args --user-data-dir=/tmp/unsafe --unsafely-treat-insecure-origin-as-secure=http://localhost

Linux

/path/to/chrome --user-data-dir=/tmp/unsafe --unsafely-treat-insecure-origin-as-secure=http://localhost

Windows

chrome.exe --user-data-dir=c:\temp --unsafely-treat-insecure-origin-as-secure=http://localhost

4. Now you can observe network traffic in the Network tab or SW activity in Application > Service Workers in Developer Tools

Stack

The app was built using these aweseome technologies

• Webpack 3.5
• React 16.x
• Redux 3.7
• React Router 4
• Reselect
• Babel
• Prettier
• Jest
• Flow
• Yarn
• Ducks 🐣
• Sass
• Autoprefixer
• D3

Yarn Scripts

• yarn - install dependencies
• yarn start - run development server
• yarn run prod - run production server
• yarn run build - build app for deployment
• yarn run serve - serve previously built app using pushstate server
• yarn run lint - lint check
• yarn run lint:fix - lint check + autofixes + prettify code with prettier
• yarn run test - run test suite
• yarn run test:fix - run test suite watching files for changes
• yarn run flow - run flow type checking
• yarn run update-types - update flow library definitions

NPM Scripts

Similar to Yarn, really...

• npm install - install dependencies
• npm start - run development server
• npm run prod - run production server
• npm run build - build app for deployment
• npm run serve - serve previously built app using pushstate server
• npm run lint - lint check
• npm run lint:fix - lint check + autofixes + prettify code with prettier
• npm run test - run test suite
• npm run test:fix - run test suite watching files for changes
• npm run flow - run flow type checking
• npm run update-types - update flow library definitions

Honorary Mentions

• Thanks to React experts at Modus Create, particularly Tim Eagan, Jason Malfatto, Brice Mason, and Esteban Las for infinite amounts of experience poured into this app
• Kudos to Andrea Grisogono who Scrumorganized the team
• Thanks to community contributors who helped with code and screamed about issues. Yeah, we really do appreciate all the screaming.
• Addy Osmani and Sam Saccone who helped with the PRPL pattern
• Sean T Larkin who helped with Webpack wizardry

Want more?

This project is maintained by Modus Create. Fantastic React apps are in our DNA so give us a buzz if we can help with your awesome project.

License

MIT