Skip to content

Latest commit

 

History

History
71 lines (46 loc) · 2.66 KB

README.md

File metadata and controls

71 lines (46 loc) · 2.66 KB
Raw

electron-react-boilerplate

NPM version Dependency Status

Electron application boilerplate based on React, React Router, Webpack, React Hot Loader for rapid application development

Warning: react-hot-reload maybe temporarily fail because ws issue with latest node and iojs Automattic/engine.io-client#376

Install

Install dependencies.

$ npm install

Run

npm run hot-dev-server
npm run start-hot

To start a react-hot electron app development !

Please make sure you have a electron environment variable which is linked to your Electron binary in your terminal. Otherwise you should refer Run your app document for run this on your computer.

Package

npm run package

Options

  • --name, -n: Application name (default: ElectronReact)
  • --version, -v: Electron version (default: latest version)
  • --asar, -a: asar support (default: false)
  • --icon, -i: Application icon
  • --all: pack for all platforms

Use electron-packager to pack your app with --all options for darwin (osx), linux and win32 (windows) platform. After build, you will find them in release folder. Otherwise, you will only find one for your os.

test, tools, release folder and devDependencies in package.json will be ignored by default.

Default Ignore modules

We add some module's peerDependencies to ignore option as default for application size reduction.

  • babel-core is required by babel-loader and its size is ~19 MB
  • node-libs-browser is required by webpack and its size is ~3MB.

Note: If you want to use any above modules in runtime, for example: require('babel/register'), you should move them form devDependencies to dependencies.

To Do

  • simplify webpack config
  • yeoman generator
  • support react devtools when atom/electron#915 fixed
  • prerender production html

License

MIT © C. T. Lin