JSPM

  • Created
  • Published
  • Downloads 5590
  • Score
    100M100P100Q127744F
  • License MIT

A Vue Cli 3 plugin for Electron with no required configuration

Package Exports

  • vue-cli-plugin-electron-builder
  • vue-cli-plugin-electron-builder/lib/testWithSpectron

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vue-cli-plugin-electron-builder) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Vue CLI Plugin Electron Builder

A Vue Cli 3 plugin for Electron with no required configuration that uses Electron Builder.

Windows (Appveyor): Build status, Linux (Travis): Build Status, Greenkeeper: Greenkeeper badge

IMPORTANT: Your app must be created with Vue-CLI 3 (vue create my-app), will not work with Vue-CLI 2 (vue init webpack my-app)!

IMPORTANT: These docs are for the v1.0.0 release of VCP Electron Builder. If you were previously using an older version of vue-cli-plugin-electron-builder (<1.0.0), please see the upgrade guide or view the old docs.

Quick Start:

Open a terminal in the directory of your app created with Vue-CLI 3.

Then, install and invoke the generator of vue-cli-plugin-electron-builder by running:

vue add electron-builder

That's It! You're ready to go!

To start a development server:

If you use Yarn (strongly recommended):

yarn electron:serve

or if you use NPM:

npm run electron:serve

To build your app:

With Yarn:

yarn electron:build

or with NPM:

npm run electron:build

To see more documentation, visit our website.

WARNING

The command names have changed in v1.0.0-rc.4. If you are using an older version, the command names are: yarn serve:electron and yarn build:electron.

Replace yarn with npm run if you are using npm.