@ytsteven/vue-cli-plugin-electron-builder
Version:
Easily Build Your Vue.js App For Desktop With Electron
58 lines (32 loc) • 4.76 kB
Markdown
# Vue CLI Plugin Electron Builder
> Easily Build Your Vue.js App For Desktop With Electron
Build status: [](https://github.com/nklayman/vue-cli-plugin-electron-builder/actions)
[](https://github.com/sponsors/nklayman)
## Top Supporters
| [](https://github.com/Glenn-Frank) |
| ---------------------------------------------------------------------------------------------------------- |
| [Glenn Frank](https://github.com/Glenn-Frank) |
## Quick Start:
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](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/durairajasivam) | [](https://github.com/Christopher-Hayes) | [](https://github.com/centerorbit) | [](https://vircadia.com/vision/) | [](https://github.com/Ivorzk) | [](https://github.com/eschirtz) | [](https://github.com/alectrocute) |
| --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
| [Yves Hoppe](https://github.com/yvesh) | [durairajasivam](https://github.com/durairajasivam) | [Chris Hayes](https://github.com/Christopher-Hayes) | [Andrew LeTourneau](https://github.com/centerorbit) | [Kalila Lakeworth](https://vircadia.com/vision/) | [Ivorzk](https://github.com/Ivorzk) | [Eric Schirtzinger](https://github.com/eschirtz) | [Alec Armbruster](https://github.com/alectrocute) |
## Past Supporters
| [<img src="https://avatars2.githubusercontent.com/u/46167401?s=64&v=4" width="64">](https://github.com/Mary-Tyler-Moore) | [](https://github.com/mitchdennett) |
| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
| [Mary-Tyler-Moore](https://github.com/Mary-Tyler-Moore) | [Mitch Dennet](https://github.com/mitchdennett) |