3sc-desktop

3 Strand Code's desktop app.

Install

npm install

Run

Run the development environment.

npm run start:hot & npm run hot:server

Toggle Chrome DevTools

• 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.

Toggle Redux DevTools

• All platforms: Ctrl+H

See redux-devtools-dock-monitor for more information.

Externals

3rd party libraries which can't be built with webpack must be list in webpack.base.babel.js：

externals: [
  // 3rd party libraries which can't be built with webpack (mysql, mongodb, and so on..)
]

You can find those lines in the file.

CSS Modules

This project is configured to use css-modules.

All .css file extensions will use css-modules unless it has .global.css.

Global styles, stylesheets with .global.css will not go through the css-modules loader. e.g. app.global.css

Package

npm run package

To package apps for all platforms:

npm run package:all

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 from devDependencies to dependencies.

Building windows apps from non-windows platforms

See Building windows apps from non-windows platforms.

License

Apache License 2.0 © 3 Strand Code, LLC