README.md

electron-react-redux-boilerplate

A minimal boilerplate to get started with Electron, React and Redux.

Including:

• React Router
• Redux Thunk
• Redux Actions
• Redux Local Storage
• Electron Packager
• Electron DevTools Installer
• Electron Mocha
• Browsersync

Quick start

Clone the repository

git clone --depth=1 [email protected]:jschr/electron-react-redux-boilerplate.git

Install dependencies

cd electron-react-redux-boilerplate
npm install

Development

npm run develop

DevTools

Toggle DevTools:

• OSX: Cmd Alt I or F12
• Linux: Ctrl Shift I or F12
• Windows: Ctrl Shift I or F12

Packaging

Modify electron-builder.yml to edit package info.

For a full list of options see: https://github.com/electron-userland/electron-builder/wiki/Options.

Create a package for OSX, Windows and Linux

npm run pack

Or target a specific platform

npm run pack:mac
npm run pack:win
npm run pack:linux

Tests

npm run test

Maintainers

• @jschr
• @pronebird

Apps using this boilerplate

• Mullvad VPN app
• YouTube Downloader Electron