A Vue Cli 3 plugin for Electron with no required configuration
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github [skip ci] meta(issue template): request electron version in bug report Nov 21, 2018
.vscode [skip ci] chore: remove unused files Oct 30, 2018
__mocks__ add support for testing and debugging Jul 5, 2018
__tests__ feat(build/serve): add process.env.IS_ELECTRON, fixes #181 Jan 13, 2019
docs [skip ci] docs(common issues): Electron not opening on Node 11 Nov 23, 2018
generator fix(generator): run install-app-deps on postuninstall, fixes #168 Dec 28, 2018
lib feat(build/serve): add process.env.IS_ELECTRON, fixes #181 Jan 13, 2019
.dockerignore [skip ci] add __tests__/projects to .dockerignore Aug 15, 2018
.eslintrc.js merge tests into v1-dev branch as they work now (#28) Jun 29, 2018
.gitignore Create new documentation website Jul 7, 2018
.npmignore [skip ci] meta(.npmignore): add development files to .npmignore Nov 11, 2018
.travis.yml update travis config to use greenkeeper-lockfile Aug 8, 2018
Dockerfile feat(tests): allow tests to run in Docker Aug 11, 2018
LICENSE [skip ci] add licence file Jul 1, 2018
README.md [skip ci] docs: prepare for v1.0.0-rc.4 release Oct 18, 2018
UPGRADING.md Create new documentation website Jul 7, 2018
appveyor.yml tests(appveyor): build both for node 8 and 10 Aug 9, 2018
deployDocs.js [skip ci] docs(deploy): add progress indicators to deployDocs script Nov 23, 2018
docker-entrypoint.sh feat(tests): allow tests to run in Docker Aug 11, 2018
index.d.ts [skip ci] fix(build/serve): rename commands to electron:command Sep 21, 2018
index.js fix(build): use publicPath as well as baseUrl, fixes #177 Jan 9, 2019
jest.config.js feat(testWithSpectron): vue add option for testing with spectron Nov 6, 2018
logo.png feat(ui): Add cli ui support Jun 20, 2018
package.json v1.0.0-rc.10 Dec 22, 2018
prompts.js [skip ci] fix(generator): set default electron version to ^3.0.0 Dec 22, 2018
testSetup.js [skip ci] tests(fix): prevent EEXIST error on async tests Aug 17, 2018
ui.js fix(ui): remove broken ui pages from dashboard, fixes #48 Jan 13, 2019
uiOptions.js feat(ui): Add cli ui support Jun 20, 2018
vue-cli-service-custom-1.tgz update @vue/cli-service custom package Jun 18, 2018
vue-cli-service-custom-2.tgz [skip ci] update custom vue-cli-service (fix linebreaks issue) Jul 28, 2018
vue-cli-service-v3.0.0-rc.2.tgz update @vue/cli-service custom release Jun 18, 2018
yarn.lock feat(package): upgrade deps, electron to ^4.0.0 Dec 22, 2018

README.md

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