README

<div align="center"><strong>Start your next react project in seconds</strong></div> <div align="center">A highly scalable, offline-first foundation with the best DX and a focus on performance and best practices</div> <div align="center"> <!-- Dependency Status --> <a href="https://david-dm.org/react-boilerplate/react-boilerplate"> </a> <!-- devDependency Status --> <a href="https://david-dm.org/react-boilerplate/react-boilerplate#info=devDependencies"> </a> <!-- Build Status --> <a href="https://travis-ci.org/react-boilerplate/react-boilerplate"> </a> <!-- Test Coverage --> <a href="https://coveralls.io/r/react-boilerplate/react-boilerplate"> </a> <a href="https://spectrum.chat/react-boilerplate"> </a> </div> <div align="center"> <!-- Backers --> <a href="#backers"> </a> <!-- Sponsors --> <a href="#sponsors"> </a> <a href="http://thinkmill.com.au/?utm_source=github&utm_medium=badge&utm_campaign=react-boilerplate"> </a> </div> <div align="center"> _{Created by <a href="https://twitter.com/mxstbr">Max Stoiber</a> and maintained with ❤️ by an amazing <a href="https://github.com/orgs/react-boilerplate/people">team of developers</a>.} </div>

Features

<dl> <dt>Quick scaffolding</dt> <dd>Create components, containers, routes, selectors and sagas - and their tests - right from the CLI!</dd> <dt>Instant feedback</dt> <dd>Enjoy the best DX (Developer eXperience) and code your app at the speed of thought! Your saved changes to the CSS and JS are reflected instantaneously without refreshing the page. Preserve application state even when you update something in the underlying code!</dd> <dt>Predictable state management</dt> <dd>Unidirectional data flow allows for change logging and time travel debugging.</dd> <dt>Next generation JavaScript</dt> <dd>Use template strings, object destructuring, arrow functions, JSX syntax and more.</dd> <dt>Next generation CSS</dt> <dd>Write composable CSS that's co-located with your components for complete modularity. Unique generated class names keep the specificity low while eliminating style clashes. Ship only the styles that are on the page for the best performance.</dd> <dt>Industry-standard routing</dt> <dd>It's natural to want to add pages (e.g. `/about`) to your application, and routing makes this possible.</dd> <dt>Industry-standard i18n internationalization support</dt> <dd>Scalable apps need to support multiple languages, easily add and support multiple languages with `react-intl`.</dd> <dt>Offline-first</dt> <dd>The next frontier in performant web apps: availability without a network connection from the instant your users load the app.</dd> <dt>Static code analysis</dt> <dd>Focus on writing new features without worrying about formatting or code quality. With the right editor setup, your code will automatically be formatted and linted as you work.</dd> <dt>SEO</dt> <dd>We support SEO (document head tags management) for search engines that support indexing of JavaScript content. (eg. Google)</dd> </dl>

But wait... there's more!

• The best test setup: Automatically guarantee code quality and non-breaking changes. (Seen a react app with 100% test coverage before?)
• Native web app: Your app's new home? The home screen of your users' phones.
• The fastest fonts: Say goodbye to vacant text.
• Stay fast: Profile your app's performance from the comfort of your command line!
• Catch problems: AppVeyor and TravisCI setups included by default, so your tests get run automatically on Windows and Unix.

There’s also a <a href="https://vimeo.com/168648012">fantastic video</a> on how to structure your React.js apps with scalability in mind. It provides rationale for the majority of boilerplate's design decisions.

_{<i>Keywords: React.js, Redux, Hot Reloading, ESNext, Babel, react-router, Offline First, ServiceWorker, styled-components, redux-saga, FontFaceObserver</i>}

Quick start

1. Make sure that you have Node.js v8.15.1 and npm v5 or above installed.

2. Clone this repo using git clone --depth=1 https://github.com/react-boilerplate/react-boilerplate.git <YOUR_PROJECT_NAME>

3. Move to the appropriate directory: cd <YOUR_PROJECT_NAME>.

4. Run npm run setup in order to install dependencies and clean the git repo.

   At this point you can run npm start to see the example app at http://localhost:3000.

5. Run npm run clean to delete the example app.

Now you're ready to rumble!

Please note that this boilerplate is production-ready and not meant for beginners! If you're just starting out with react or redux, please refer to https://github.com/petehunt/react-howto instead. If you want a solid, battle-tested base to build your next product upon and have some experience with react, this is the perfect start for you.

Documentation

• The Hitchhiker's Guide to react-boilerplate: An introduction for newcomers to this boilerplate.
• Overview: A short overview of the included tools
• Commands: Getting the most out of this boilerplate
• Testing: How to work with the built-in test harness
• Styling: How to work with the CSS tooling
• Your app: Supercharging your app with Routing, Redux, simple asynchronicity helpers, etc.
• Troubleshooting: Solutions to common problems faced by developers.

Contributors

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore --> <table><tr><td align="center"><a href="https://mxstbr.com"> _{<b>Max Stoiber</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=mxstbr" title="Code">💻</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=mxstbr" title="Documentation">📖</a> <a href="#ideas-mxstbr" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-mxstbr" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=mxstbr" title="Tests">⚠️</a></td><td align="center"><a href="https://julien.engineering/"> _{<b>Julien Benchetrit</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=julienben" title="Code">💻</a> <a href="#question-julienben" title="Answering Questions">💬</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=julienben" title="Documentation">📖</a> <a href="#review-julienben" title="Reviewed Pull Requests">👀</a> <a href="#maintenance-julienben" title="Maintenance">🚧</a></td><td align="center"><a href="http://sarafederi.co"> _{<b>Sara Federico</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=gretzky" title="Code">💻</a> <a href="#review-gretzky" title="Reviewed Pull Requests">👀</a> <a href="#question-gretzky" title="Answering Questions">💬</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=gretzky" title="Documentation">📖</a> <a href="#maintenance-gretzky" title="Maintenance">🚧</a></td><td align="center"><a href="https://justingreenberg.com"> _{<b>Justin Greenberg</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=justingreenberg" title="Code">💻</a> <a href="#review-justingreenberg" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://github.com/jwinn"> _{<b>Jon Winn</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=jwinn" title="Code">💻</a> <a href="#review-jwinn" title="Reviewed Pull Requests">👀</a></td><td align="center"><a href="https://meester-johan.info/"> _{<b>Johan Meester</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=Mensae" title="Code">💻</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=Mensae" title="Tests">⚠️</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=Mensae" title="Documentation">📖</a></td><td align="center"><a href="https://github.com/Dattaya"> _{<b>Yaroslav Kiliba</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=Dattaya" title="Code">💻</a></td><td align="center"><a href="https://github.com/gihrig"> _{<b>Glen Ihrig</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=gihrig" title="Code">💻</a></td></tr><tr><td align="center"><a href="https://github.com/somus"> _{<b>Somasundaram Ayyappan</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=somus" title="Code">💻</a></td><td align="center"><a href="https://www.codedsignal.co.uk/"> _{<b>Oliver Turner</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=oliverturner" title="Code">💻</a></td><td align="center"><a href="https://github.com/samit4me"> _{<b>Samuel Sharpe</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=samit4me" title="Code">💻</a></td><td align="center"><a href="https://karandikarmihir.github.io/"> _{<b>Mihir Karandikar</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=KarandikarMihir" title="Code">💻</a></td><td align="center"><a href="http://www.vverma.net"> _{<b>Vaibhav Verma</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=v" title="Code">💻</a></td><td align="center"><a href="https://imagineclarity.com"> _{<b>Sébastien Dubois</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=sedubois" title="Code">💻</a></td><td align="center"><a href="https://www.chaintng.com"> _{<b>Chainarong Tangsurakit</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=chaintng" title="Code">💻</a></td><td align="center"><a href="https://amilajack.com"> _{<b>Amila Welihinda</b>}</a> <a href="https://github.com/react-boilerplate/react-boilerplate/commits?author=amilajack" title="Code">💻</a></td></tr></table> <!-- ALL-CONTRIBUTORS-LIST:END -->

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

Supporters

This project would not be possible without the support of these amazing folks. Become a sponsor to get your company in front of thousands of engaged react developers and help us out!

<a href="https://opencollective.com/react-boilerplate/bronze-sponsor/0/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/bronze-sponsor/1/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/bronze-sponsor/2/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/bronze-sponsor/3/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/bronze-sponsor/4/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/bronze-sponsor/5/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/bronze-sponsor/6/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/bronze-sponsor/7/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/bronze-sponsor/8/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/bronze-sponsor/9/website" target="_blank"></a>

---

<a href="https://opencollective.com/react-boilerplate/backer/0/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/backer/1/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/backer/2/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/backer/3/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/backer/4/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/backer/5/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/backer/6/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/backer/7/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/backer/8/website" target="_blank"></a> <a href="https://opencollective.com/react-boilerplate/backer/9/website" target="_blank"></a>

License

This project is licensed under the MIT license, Copyright (c) 2019 Maximilian Stoiber. For more information see LICENSE.md.