vue-cli-plugin-electron-builder-gz
Version:
A Vue Cli 3 plugin for Electron with no required configuration - fork with packages updates
48 lines (25 loc) • 2.86 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/).
Build status: [](https://github.com/nklayman/vue-cli-plugin-electron-builder/actions)
[](https://github.com/sponsors/nklayman)
**IMPORTANT: Your app must be created with Vue-CLI 3 or 4 (vue create my-app), will not work with Vue-CLI 2 (vue init webpack my-app)!**
## 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).
## Supporters
| [](https://github.com/yvesh) | [](https://github.com/centerorbit) | [](https://github.com/Mary-Tyler-Moore) | [](https://github.com/mitchdennett) | [](https://kasen.io) |
| --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| [Yves Hoppe](https://github.com/yvesh) | [Andrew LeTourneau](https://github.com/centerorbit) | [Mary-Tyler-Moore](https://github.com/Mary-Tyler-Moore) | [Mitch Dennet](https://github.com/mitchdennett) | [Kasen IO](https://kasen.io) |