Skip to content

Latest commit

 

History

History
87 lines (56 loc) · 3.05 KB

README.md

File metadata and controls

87 lines (56 loc) · 3.05 KB
Raw

electron-react-boilerplate

NPM version Dependency Status

Live editing development on desktop app

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

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.

Externals

If you use any 3rd party libraries which can't be built with webpack, you must list them in your webpack/make-webpack-config.js：

externals.push(
	// put your node 3rd party libraries which can't be built with webpack here (mysql, mongodb, and so on..)
)

You can find those lines in the file.

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.

Building windows apps from non-windows platforms

Please checkout Building windows apps from non-windows platforms.

To Do

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

License

MIT © C. T. Lin