@akumzy/vue-cli-plugin-electron-builder
Version:
A Vue Cli 3 plugin for Electron with no required configuration
51 lines (27 loc) • 2.03 kB
Markdown
# Vue CLI Plugin Electron Builder
A Vue Cli 3 plugin for Electron with no required configuration that uses [Electron Builder](https://www.electron.build/).
Windows (Appveyor): [](https://ci.appveyor.com/project/nklayman/vue-cli-plugin-electron-builder), Linux (Travis): [](https://travis-ci.org/nklayman/vue-cli-plugin-electron-builder), Greenkeeper: [](https://greenkeeper.io/)
**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](https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/upgrading.html) or [view the old docs](https://github.com/nklayman/vue-cli-plugin-electron-builder/tree/legacy).**
## 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](https://yarnpkg.com/en/) (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](https://nklayman.github.io/vue-cli-plugin-electron-builder/guide/guide.html).
## 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.