Skip to content
Get packs

Guide · Open source

How to use react-boilerplate: install, run and build your first app

Updated · written with AI from the project's own documentation and checked against our catalogue data

react-boilerplate is a free, MIT-licensed project template that gives you a working React and Redux app with routing, styling, translations and tests already wired together. This guide walks through the clone-and-setup process, shows what the template includes, and explains when it is a good fit. By the end you will know how to get the example app running and where to start adding your own features.

React Boilerplatereact-boilerplate/react-boilerplate · ★ 29.4k · MIT

Quick start

  1. 1Check prerequisites. Confirm Node.js v8.15.1 or later, npm v5 or above and git are installed.
  2. 2Clone the repository. Run the shallow git clone command with your project name in place of <YOUR_PROJECT_NAME>.
  3. 3Move into the folder. Change into the directory that git created.
  4. 4Run the setup script. Run npm run setup to install dependencies and clean the git repo.
  5. 5Start the example app. Run npm start and open http://localhost:3000 in your browser.
  6. 6Remove the example when ready. Run npm run clean to delete the example app before building your own features.

What react-boilerplate gives you

react-boilerplate is a pre-built project template. Instead of connecting React, Redux, routing, styling, translations and tests yourself, you start from a project where these are already set up, then write your own features on top.

The README lists several included capabilities: scaffolding of components, containers, routes, selectors and sagas from the command line, routing for pages such as /about, i18n support with react-intl, offline-first behaviour, and linting and formatting. It also mentions CSS co-located with components and an AppVeyor and TravisCI setup so tests run on Windows and Unix.

  • Quick scaffolding of components, containers, routes, selectors and sagas, with their tests
  • Routing for adding pages
  • Multi-language support with react-intl
  • Offline-first design
  • Static code analysis for formatting and linting

Check the requirements before you install

You need Node.js and npm installed, plus git to clone the repository. The README asks for Node.js v8.15.1 or later and npm v5 or above.

  • Node.js v8.15.1 or later
  • npm v5 or above
  • git

Install react-boilerplate and run the example app

Clone the repository with a shallow clone, move into the folder you created, then run the setup script. The setup script installs dependencies and cleans the git repo so the project starts fresh.

Once setup finishes, run npm start to see the example app. The README says it runs at http://localhost:3000. When you no longer need the example, npm run clean deletes it.

git clone --depth=1 https://github.com/react-boilerplate/react-boilerplate.git <YOUR_PROJECT_NAME> cd <YOUR_PROJECT_NAME> npm run setup npm start

Find your way around the documentation

The project ships with its own documentation. Start with the introduction for newcomers, then use the commands guide to get the most out of the boilerplate. The troubleshooting page covers common problems.

  • Introduction: docs/general/introduction.md
  • Commands: docs/general/commands.md
  • Testing: docs/testing
  • Styling: docs/css
  • Your app (routing, Redux, async helpers): docs/js
  • Troubleshooting: docs/general/gotchas.md

Know who this template suits

react-boilerplate is aimed at experienced React developers starting a production web app, and at teams that want one consistent structure and conventions. The README states it is not meant for beginners and points to a separate guide, react-howto, for people new to React or Redux.

It can be more than a small project needs. The template includes many tools, so a one-page site may be better served by a simpler setup.

What people use it for

  • Starting a new production web app with React and Redux already configured
  • Setting up a team project with a shared folder structure and conventions
  • Building a multi-language app where translations are needed from the start
  • Generating components, routes and sagas with their tests from the command line

Frequently asked questions

Is react-boilerplate free to use?

Yes, react-boilerplate is released under the MIT licence, as listed on its repository. You can clone it and build your own project from it.

What are the requirements for react-boilerplate?

The README asks for Node.js v8.15.1 or later, npm v5 or above, and git. Make sure all three are installed before you clone the repository.

How do I install react-boilerplate?

Clone the repository with git clone --depth=1, move into the folder, and run npm run setup. The setup script installs dependencies and cleans the git repo.

Is react-boilerplate good for beginners?

No. The README says the boilerplate is production-ready and not meant for beginners, and it recommends learning React and Redux basics first using the react-howto guide.

How does react-boilerplate compare to Create React App or Vite?

Create React App, Vite, Next.js and the Redux Toolkit template are comparable projects. react-boilerplate differs by bundling Redux, routing, i18n and tests into one opinionated template, which suits teams that want that structure from day one.

Why does the example app not start?

The README points to a troubleshooting page at docs/general/gotchas.md for common problems. Check that you meet the Node.js and npm version requirements first.

New agent skills, repos and AI tools — every week

The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.

Our verdict

Choose react-boilerplate if you have React experience, are starting a production app, and want routing, Redux, translations and tests set up with shared conventions. Pick a simpler tool such as Vite or Create React App if you are new to React or are building a small one-page site that does not need the extra tooling.

Install options & downloads