Electron React Boilerplate uses Electron, React, React Router, Webpack and React Fast Refresh.


[![Build Status][github-actions-status]][github-actions-url] [![Dependency Status][david-image]][david-url] [![DevDependency Status][david-dev-image]][david-dev-url] [![Github Tag][github-tag-image]][github-tag-url] [![OpenCollective](https://opencollective.com/electron-react-boilerplate/backers/badge.svg)](#backers) [![OpenCollective](https://opencollective.com/electron-react-boilerplate/sponsors/badge.svg)](#sponsors) [![Good first issues open][good-first-issue-image]][good-first-issue-url] [![StackOverflow][stackoverflow-img]][stackoverflow-url]
## Install - **If you have installation or compilation issues with this project, please see [our debugging guide](https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues/400)** First, clone the repo via git and install dependencies: ```bash git clone --depth 1 --single-branch https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name cd your-project-name yarn ``` ## Starting Development Start the app in the `dev` environment: ```bash yarn start ``` ## Packaging for Production To package apps for the local platform: ```bash yarn package ``` ## Docs See our [docs and guides here](https://electron-react-boilerplate.js.org/docs/installation) ## Donations **Donations will ensure the following:** - 🔨 Long term maintenance of the project - 🛣 Progress on the [roadmap](https://electron-react-boilerplate.js.org/docs/roadmap) - 🐛 Quick responses to bug reports and help requests ## Backers Support us with a monthly donation and help us continue our activities. [[Become a backer](https://opencollective.com/electron-react-boilerplate#backer)] ## Sponsors Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/electron-react-boilerplate-594#sponsor)] ## Maintainers - [Amila Welihinda](https://github.com/amilajack) - [John Tran](https://github.com/jooohhn) - [C. T. Lin](https://github.com/chentsulin) - [Jhen-Jie Hong](https://github.com/jhen0409) ## License MIT © [Electron React Boilerplate](https://github.com/electron-react-boilerplate) [github-actions-status]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/workflows/Test/badge.svg [github-actions-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/actions [github-tag-image]: https://img.shields.io/github/tag/electron-react-boilerplate/electron-react-boilerplate.svg?label=version [github-tag-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/releases/latest [stackoverflow-img]: https://img.shields.io/badge/stackoverflow-electron_react_boilerplate-blue.svg [stackoverflow-url]: https://stackoverflow.com/questions/tagged/electron-react-boilerplate [david-image]: https://img.shields.io/david/electron-react-boilerplate/electron-react-boilerplate.svg [david-url]: https://david-dm.org/electron-react-boilerplate/electron-react-boilerplate [david-dev-image]: https://img.shields.io/david/dev/electron-react-boilerplate/electron-react-boilerplate.svg?label=devDependencies [david-dev-url]: https://david-dm.org/electron-react-boilerplate/electron-react-boilerplate?type=dev [good-first-issue-image]: https://img.shields.io/github/issues/electron-react-boilerplate/electron-react-boilerplate/good%20first%20issue.svg?label=good%20first%20issues [good-first-issue-url]: https://github.com/electron-react-boilerplate/electron-react-boilerplate/issues?q=is%3Aopen+is%3Aissue+label%3A"good+first+issue"