Electron application boilerplate based on React, Redux, React Router, Webpack, React Transform HMR for rapid application development
- Note: requires a node version >= 6 and an npm version >= 3.
- 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 https://github.com/chentsulin/electron-react-boilerplate.git your-project-name
And then install dependencies. ProTip: Install with yarn for faster and safer installation:
$ cd your-project-name && npm install
Start the app in the dev
environment. This starts the renderer process in hot-module-replacement mode and starts a server sends hot updates to the renderer process:
$ npm run dev
You Run these two commands simultaneously in different console tabs:
$ npm run hot-updates-server
$ npm run start-hot-renderer
Atom
apm install editorconfig es6-javascript atom-ternjs javascript-snippets linter linter-eslint language-babel autocomplete-modules file-icons
VSCode
- Editorconfig
- ESLint
- Flow
- Babel
- Jest
- ES6 Snippets
- React Snippets
💡 If you are using the
flow-for-vscode
plugin, make sure to disable theflowtype-errors/show-errors
eslint rule in the.eslintrc
by setting it to0
Sublime
- Editorconfig Integration
- Linting
- ESLint Integration
- Syntax Highlighting
- Autocompletion
- Node Snippets
- ES6 Snippets
Others
- Editorconfig
- ESLint
- Babel Syntax Plugin
- OS X: Cmd Alt I or F12
- Linux: Ctrl Shift I or F12
- Windows: Ctrl Shift I or F12
See electron-debug for more information.
This boilerplate is included following DevTools extensions:
- Devtron - Install via electron-debug.
- React Developer Tools - Install via electron-devtools-installer.
- Redux DevTools - Install via electron-devtools-installer.
You can find the tabs on Chrome DevTools.
If you want to update extensions version, please set UPGRADE_EXTENSIONS
env, just run:
$ UPGRADE_EXTENSIONS=1 npm run dev
# For Windows
$ set UPGRADE_EXTENSIONS=1 && npm run dev
💡 You can debug your production build with devtools by simply setting the DEBUG_PROD
env variable:
DEBUG_PROD=true npm run package
This boilerplate out of the box is configured to use css-modules.
All .css
file extensions will use css-modules unless it has .global.css
.
If you need global styles, stylesheets with .global.css
will not go through the
css-modules loader. e.g. app.global.css
If you want to import global css libraries (like bootstrap
), you can just write the following code in .global.css
:
@import "~bootstrap/dist/css/bootstrap.css";
If you want to use Sass in your app, you only need to import .sass
files instead of .css
once:
import './app.global.scss';
To package apps for the local platform:
$ npm run package
To package apps for all platforms:
First, refer to Multi Platform Build for dependencies.
Then,
$ npm run package-all
To package apps with options:
$ npm run package -- --[option]
To run the application without packaging run
$ npm run build
$ npm start
To run End-to-End Test
$ npm run build
$ npm run test-e2e
See electron-builder CLI Usage
You will need to add other modules to this boilerplate, depending on the requirements of your project. For example, you may want to add node-postgres to communicate with PostgreSQL database, or material-ui to reuse react UI components.
This boilerplate uses a two package.json structure. This means, you will have two package.json
files.
./package.json
in the root of your project./app/package.json
insideapp
folder
Rule of thumb is: all modules go into ./package.json
except native modules. Native modules go into ./app/package.json
.
- If the module is native to a platform (like node-postgres) or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under
dependencies
in./app/package.json
. - If a module is
import
ed by another module, include it independencies
in./package.json
. See this ESLint rule. Examples of such modules arematerial-ui
,redux-form
, andmoment
. - Otherwise, modules used for building, testing and debugging should be included in
devDependencies
in./package.json
.
See the wiki page, Module Structure — Two package.json Structure to understand what is native module, the rationale behind two package.json structure and more.
For an example app that uses this boilerplate and packages native dependencies, see erb-sqlite-example.
This project comes with Flow support out of the box! You can annotate your code with types, get Flow errors as ESLint errors, and get type errors during runtime during development. Types are completely optional.
If you want to have native-like User Interface (OS X El Capitan and Windows 10), react-desktop may perfect suit for you.
see discusses in #118 and #108
If your application is a fork from this repo, you can add this repo to another git remote:
git remote add upstream https://github.com/chentsulin/electron-react-boilerplate.git
Then, use git to merge some latest commits:
git pull upstream master
Support us with a monthly donation and help us continue our activities. [Become a backer]
Become a sponsor and get your logo on our README on Github with a link to your site. [Become a sponsor]
MIT © C. T. Lin