React Electron Boilerplate

About

Electron has main process and render process. The main process is responsible for creating and managing BrowserWindow instances and various application events. It can also do things like register global shortcuts, create native menus and dialogs, respond to auto-update events, and more. The render process is responsible for running the user-interface of your app, or in other words, a web page.

React is a really popular JavaScript library for building user interface, and it's perfect for building the web page for Electron.

How to integrate Electron and React? And how to setup the folder structure that helps organize the source codes for both main process and render process? Basically we can put all the source codes related to the main process in src/main folder, and those handle render process are in src/renderer folder.

We use Webpack to bundle the assets for the main process and render process, respectively. And Jest is used for running tests.

You can use this boilerplate to scaffold your Electron project, it has a Todo list app that shows your how to use React with Redux and Ract Router, it supports localization as well, or feel free to use this project as a reference.

Features

Quick scaffolding
Save your time in putting Electron, React, Redux, Router, Webpack, Jest and localization together, so you can focus on coding your awesome desktop application.

Basic react eco system
The scaffolded project will include the latest React, Redux, React Router and React Intl.

Installer distribution
We use Electron Builder and its two package.json structure.

• Link for prerequisites of generating installers on different platforms.
• Link for code signing.

Webpack
Enjoy the tree shaking feature in Webpack.

Jest
Facebook's painless JavaScript test runner, no need to configure Karma Webpack, no need to use Sinon and Babel Rewire.

Quick start

Get up and running

1. Clone this repo using git clone https://github.com/jeantimex/react-electron-boilerplate.git
2. Run yarn or npm install to install the dependencies
3. Run yarn run dev or npm run dev to see the example electron app

4. Run yarn run test to trigger eslint, jest with coverage report

 PASS  tests/renderer/components/todos/Todos.spec.js
 PASS  tests/renderer/reducers/TodoReducer.spec.js
 PASS  tests/renderer/actions/index.spec.js

Test Suites: 3 passed, 3 total
Tests:       28 passed, 28 total
Snapshots:   0 total
Time:        5.811s
Ran all test suites.
------------------|----------|----------|----------|----------|----------------|
File              |  % Stmts | % Branch |  % Funcs |  % Lines |Uncovered Lines |
------------------|----------|----------|----------|----------|----------------|
All files         |      100 |      100 |      100 |      100 |                |
 components/todos |      100 |      100 |      100 |      100 |                |
  Todos.js        |      100 |      100 |      100 |      100 |                |
 reducers         |      100 |      100 |      100 |      100 |                |
  TodoReducer.js  |      100 |      100 |      100 |      100 |                |
------------------|----------|----------|----------|----------|----------------|

Build platform installer

• Mac: Run yarn run pack:mac
• Windows: Run yarn run pack:win
• Linux: Run yarn run pack:linux
• All platforms: Run yarn run pack

Here is an example of launching the dmg file on Mac:

Documents

• Electron
  • Folder structure
  • Electron Builder
• Babel
• React
  • Redux
  • Router
  • Localization
• Webpack
• Unit Testing

License

MIT License

Copyright (c) 2017 Yong Su @jeantimex

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.