Live editing development on desktop app
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 https://github.com/chentsulin/electron-react-boilerplate.git your-project-nameAnd then install dependencies. ProTip: Install with yarn for faster and safer installation
$ cd your-project-name && npm install💡 In order to remove boilerplate sample code, simply run npm run cleanup. After this is run, the initial sample boilerplate code will be removed in order for a clean project for starting custom dev
Run these two commands simultaneously in different console tabs.
$ npm run hot-server
$ npm run start-hotor run two servers with one command
$ npm run devAtom
apm install editorconfig es6-javascript atom-ternjs javascript-snippets linter linter-eslint language-babel autocomplete-modulesSublime
- https://github.com/sindresorhus/editorconfig-sublime#readme
- https://github.com/SublimeLinter/SublimeLinter3
- https://github.com/roadhump/SublimeLinter-eslint
- https://github.com/babel/babel-sublime
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 devThis 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";To package apps for the local platform:
$ npm run packageTo package apps for all platforms:
First, refer to Multi Platform Build for dependencies.
Then,
$ npm run package-allTo package apps with options:
$ npm run package -- --[option]To run the application without packaging run
$ npm run build
$ npm startTo run End-to-End Test
$ npm run build
$ npm run test-e2eSee electron-builder CLI Usage
This boilerplate uses a two package.json structure.
- If the module is native to a platform or otherwise should be included with the published package (i.e. bcrypt, openbci), it should be listed under
dependenciesin./app/package.json. - If a module is
imported by another module, include it independenciesin./package.json. See this ESLint rule. - Otherwise, modules used for building, testing and debugging should be included in
devDependenciesin./package.json.
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.gitThen, use git to merge some latest commits:
git pull upstream masterMIT © C. T. Lin