WARNING

These are the docs for the v3.x.x release line, which is recommended over the v2.x version. The old docs are available here (opens new window). To upgrade, see the release announcement (opens new window).

Quick Start

Installation

Open a terminal in the directory of your app created with Vue-CLI 3 or 4 (4 is recommended).

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 (opens new window):

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