Electron Build Commands

Quasar CLI makes it incredibly simple to develop or build the final distributables from your source code.

Developing

$ quasar dev -m electron

# ..or the longer form:
$ quasar dev --mode electron

# passing extra parameters and/or options to
# underlying "electron" executable:
$ quasar dev -m electron -- --no-sandbox --disable-setuid-sandbox

It opens up an Electron window with dev-tools included. You have HMR for the renderer process and changes to main process are also picked up (but the latter restarts the Electron window on each change).

Check how you can tweak Webpack config Object for the Main Process on the Configuring Electron page.

Building for Production

$ quasar build -m electron

# ..or the longer form:
$ quasar build --mode electron

It builds your app for production and then uses electron-packager to pack it into an executable. Check how to configure this on Configuring Electron page.

A note for non-Windows users

If you want to build for Windows with a custom icon using a non-Windows platform, you must have wine installed. More Info.

Publishing (electron-builder only)

$ quasar build -m electron -P always

# ..or the longer form:
$ quasar dev --mode electron --publish always

You can specify using electron-builder to build your app either directly on the command line (--bundler builder) or by setting it explicitly within quasar.conf.js at electron.bundler. This flag has no effect when using electron-packager.

Currently (June 2019) supported publishing destinations include Github, Bintray, S3, Digital Ocean Spaces, or a generic HTTPS server. More information, including how to create valid publishing instructions, can be found here.

Valid options for -P are “onTag”, “onTagOrDraft”, “always” and “never” which are explained at the above link. In addition, you must have valid publish configuration instructions in your quasar.conf.js at electron.builder.

A very basic configuration to publish a Windows EXE setup file to Amazon S3 might look like this:

// quasar.conf.js

electron: {
  bundler: 'builder', // set here instead of using command line flag --bundler
  builder: {
    appId: 'com.electron.myelectronapp',
    win: {
      target: 'nsis'
    },
    publish: {
      'provider': 's3',
      'bucket': 'myS3bucket'
    }
  }