Live editing development on desktop app
Clone or download

README.md



A boilerplate for Scalable Cross-Platform Desktop Apps based on Electron, React, Redux, React Router, Webpack and React Hot Loader for rapid application development (HMR).





Build Status Appveyor Build Status Dependency Status DevDependency Status Github Tag

Join the community on Spectrum OpenCollective OpenCollective Good first issues open

Electron Boilerplate Demo

Install

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

First, clone the repo via git:

git clone --depth 1 --single-branch --branch master https://github.com/electron-react-boilerplate/electron-react-boilerplate.git your-project-name

And then install the dependencies with yarn.

$ 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

If you don't need autofocus when your files was changed, then run dev with env START_MINIMIZED=true:

$ START_MINIMIZED=true yarn dev

Packaging for Production

To package apps for the local platform:

$ yarn package

Docs

See our complete docs here

Maintainers

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]

License

MIT © Electron React Boilerplate