README.md

electron-react-mobx-boilerplate

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

Including:

• Electron Packager
• Electron DevTools Installer
• Devtron
• Babel
• Webpack
• ESLint (with Airbnb's style guide)
• Styled Components
• Flow
• Jest
• Enzyme

Quick start

Clone the repository

git clone https://github.com/niederschlag/electron-react-mobx-boilerplate.git

Install dependencies

cd electron-react-mobx-boilerplate
yarn install

Development

yarn dev

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

yarn build

Tests

yarn test

Stuff which is nice to have

• Code quality management (Codefactor / StyleCI)
• Consider adding mobx-remotedev