README.md

Electron React Boilerplate uses Electron, React, Redux, React Router, Webpack and React Hot Loader for rapid application development (HMR).

---

Install

• If you have installation or compilation issues with this project, please see our debugging guide

First, clone the repo via git and install dependencies:

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. This starts the renderer process in hot-module-replacement mode and starts a webpack dev server that sends hot updates to the renderer process:

yarn dev

Packaging for Production

To package apps for the local platform:

yarn package

Docs

See our docs and guides here

Donations

Donations will ensure the following:

• 🔨 Long term maintenance of the project
• 🛣 Progress on the 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]

Sponsors

Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]

Maintainers

• Amila Welihinda
• C. T. Lin
• Jhen-Jie Hong

License

MIT © Electron React Boilerplate