# Vue CLI Plugin Electron Builder

> Easily Build Your Vue.js App For Desktop With Electron

Build status: [![Build status](https://github.com/nklayman/vue-cli-plugin-electron-builder/workflows/Node%20CI/badge.svg)](https://github.com/nklayman/vue-cli-plugin-electron-builder/actions)

[![Sponsor](./docs/.vuepress/public/sponsorShield.svg)](https://github.com/sponsors/nklayman)

## Top Supporters

| [![Glenn Frank](https://avatars.githubusercontent.com/u/6701567?s=64&v=4)](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/):

`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

| [![Yves Hoppe](https://avatars1.githubusercontent.com/u/897638?s=64&v=4)](https://github.com/yvesh) | [![durairajasivam](https://avatars3.githubusercontent.com/u/6660533?s=64&v=4)](https://github.com/durairajasivam) | [![Chris Hayes](https://avatars3.githubusercontent.com/u/6013871?s=64)](https://github.com/Christopher-Hayes) | [![Andrew LeTourneau](https://avatars2.githubusercontent.com/u/2807807?s=64&v=4)](https://github.com/centerorbit) | [![Kalila Lakeworth](https://avatars1.githubusercontent.com/u/69767640?s=64)](https://vircadia.com/vision/) |
| --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| [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://avatars2.githubusercontent.com/u/7390138?s=64)](https://github.com/Ivorzk)       | [![Eric Schirtzinger](https://avatars2.githubusercontent.com/u/24927782?s=64)](https://github.com/eschirtz)       | [![Alec Armbruster](https://avatars2.githubusercontent.com/u/35377827?s=64)](https://github.com/alectrocute)  | [![Karim Hossenbux](https://avatars.githubusercontent.com/u/584224?s=64)](https://github.com/karimhossenbux)      |
| [Ivorzk](https://github.com/Ivorzk)                                                                 | [Eric Schirtzinger](https://github.com/eschirtz)                                                                  | [Alec Armbruster](https://github.com/alectrocute)                                                             | [Karim Hossenbux](https://github.com/karimhossenbux)                                                              |
## Past Supporters

| [<img src="https://avatars2.githubusercontent.com/u/46167401?s=64&v=4" width="64">](https://github.com/Mary-Tyler-Moore) | [![Mitch Dennet](https://avatars2.githubusercontent.com/u/16268619?s=64&v=4)](https://github.com/mitchdennett) |
| ------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------------------------- |
| [Mary-Tyler-Moore](https://github.com/Mary-Tyler-Moore)                                                                  | [Mitch Dennet](https://github.com/mitchdennett)                                                                |