React Static Boilerplate (RSB) is an opinionated boilerplate and tooling for creating modern stand-alone web applications (aka SPAs) for a serverless architecture. RSB significantly reduces cost by eliminating the need for servers such as EC2 instances because the entire site can be hosted directly from CDN (Firebase, GitHub Pages, Amazon S3, or other similar cloud storage). Sites built with RSB can be fully functional with REST API or GraphQL calls to micro-services such as Amazon Lambda, Azure Functions, or dynamic Docker endpoints hosted on DigitalOcean. RSB demonstrates how to use component-based UI development approach with best of breed technologies including React, Redux, Babel, Webpack, Browsersync, React Hot Loader and more.
The work is being sponsored by:
✓ Component-based UI architecture via React, Webpack and CSS Modules
✓ Application state management /w time-travel debugging via Redux (see
✓ Routing and navigation via
✓ Code-splitting and async chunk loading via Webpack and ES6 System.import()
✓ Hot Module Replacement (HMR) /w React Hot Loader
✓ Cross-device testing with Browsersync (see
✓ 24/7 community support on Gitter; customization requests on Codementor
. ├── /components/ # Shared or generic UI components │ ├── /Button/ # Button component │ ├── /Layout/ # Website layout component │ ├── /Link / # Link component to be used insted of <a> │ └── /... # etc. ├── /core/ # Core framework │ ├── /history.js # Handles client-side navigation │ ├── /router.js # Handles routing and data fetching │ └── /store.js # Application state manager (Redux) ├── /node_modules/ # 3rd-party libraries and utilities ├── /pages/ # React components for web pages │ ├── /about/ # About page │ ├── /error/ # Error page │ ├── /home/ # Home page │ └── /... # etc. ├── /public/ # Static files such as favicon.ico etc. │ ├── /dist/ # The folder for compiled output │ ├── favicon.ico # Application icon to be displayed in bookmarks │ ├── robots.txt # Instructions for search engine crawlers │ └── /... # etc. ├── /test/ # Unit and integration tests ├── /utils/ # Utility and helper classes │── main.js # React application entry point │── package.json # The list of project dependencies and NPM scripts │── routes.json # This list of application routes │── run.js # Build automation script, e.g. `node run build` └── webpack.config.js # Bundling and optimization settings for Webpack
Step 1. Make sure that you have Node.js v6 or newer installed on your machine.
Step 2. Clone this repository or use Yeoman generator to bootstrap your project:
$ git clone -o react-static-boilerplate -b master --single-branch \ https://github.com/kriasoft/react-static-boilerplate.git MyApp $ cd MyApp $ npm install # Install project dependencies listed in package.json
——— or ———
$ npm install -g yo $ npm install -g generator-react-static $ mkdir MyApp $ cd MyApp $ yo react-static
Step 3. Compile and launch your app by running:
$ node run # Same as `npm start` or `node run start`
You can also test your app in release (production) mode by running
node run start --release or
with HMR and React Hot Loader disabled by running
node run start --no-hmr. The app should become
available at http://localhost:3000/.
How to Test
How to Deploy
publish script in the
run.js file with your full Firebase project name as found
in your Firebase console. Note that this may have an
additional identifier suffix than the shorter name you've provided. Then run:
$ node run publish # Build and publish the website to Firebase, same as `npm run publish`
The first time you publish, you will be prompted to authenticate with Google and generate an authentication token in order for the publish script to continue.
If you need just to build the project without publishing it, run:
$ node run build # Or, `node run build --release` for production build
How to Update
You can always fetch and merge the recent changes from this repo back into your own project:
$ git checkout master $ git fetch react-static-boilerplate $ git merge react-static-boilerplate/master $ npm install
Learn React.js and ES6
- React App SDK — Create React apps with just a single dev dependency and zero configuration
- React Starter Kit — Isomorphic web app boilerplate (Node.js, React, GraphQL, Webpack, CSS Modules)
- ASP.NET Core Starter Kit — Cross-platform single-page application boilerplate (ASP.NET Core, React, Redux)
- Universal Router — Isomorphic router for web and single-page applications (SPA)
- History — HTML5 History API wrapper library that handle navigation in single-page apps
How to Contribute
Anyone and everyone is welcome to contribute to this project. The best way to start is by checking our open issues, submit a new issues or feature request, participate in discussions, upvote or downvote the issues you like or dislike, send pull requests.
Copyright © 2015-present Kriasoft, LLC. This source code is licensed under the MIT license found in the LICENSE.txt file.