# Vue CLI Plugin Electron Builder

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

[![Node CI](https://github.com/MatthijsBurgh/vue-cli-plugin-electron-builder/actions/workflows/nodeCI.yml/badge.svg)](https://github.com/MatthijsBurgh/vue-cli-plugin-electron-builder/actions/workflows/nodeCI.yml)

[![codecov](https://codecov.io/gh/MatthijsBurgh/vue-cli-plugin-electron-builder/branch/master/graph/badge.svg?token=V6OJ28JU6K)](https://codecov.io/gh/MatthijsBurgh/vue-cli-plugin-electron-builder)

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

## Top Supporters

| [![Glenn Frank](https://avatars.githubusercontent.com/u/6701567?s=64)](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 @matthijsburgh/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://MatthijsBurgh.github.io/vue-cli-plugin-electron-builder/guide/guide.html).

## Supporters

| [![Yves Hoppe](https://avatars1.githubusercontent.com/u/897638?s=64)](https://github.com/yvesh)             | [![durairajasivam](https://avatars3.githubusercontent.com/u/6660533?s=64&)](https://github.com/durairajasivam) | [![Alec Armbruster](https://avatars2.githubusercontent.com/u/35377827?s=64)](https://github.com/alectrocute) | [![Tilen Hosnar](https://avatars.githubusercontent.com/u/11992843?s=64)](https://github.com/hosnar)                       | [![Andrew LeTourneau](https://avatars2.githubusercontent.com/u/2807807?s=64)](https://github.com/centerorbit) |
| ----------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |
| [Yves Hoppe](https://github.com/yvesh)                                                                      | [durairajasivam](https://github.com/durairajasivam)                                                            | [Alec Armbruster](https://github.com/alectrocute)                                                            | [Tilen Hosnar](https://github.com/hosnar)                                                                                 | [Andrew LeTourneau](https://github.com/centerorbit)                                                           |
| [![Kalila Lakeworth](https://avatars1.githubusercontent.com/u/69767640?s=64)](https://vircadia.com/vision/) | [![Eric Schirtzinger](https://avatars2.githubusercontent.com/u/24927782?s=64)](https://github.com/eschirtz)    | [![Karim Hossenbux](https://avatars.githubusercontent.com/u/584224?s=64)](https://github.com/karimhossenbux) | [![Decentralized Justice](https://avatars.githubusercontent.com/u/38048901?s=64)](https://github.com/DecentralizeJustice) |
| [Kalila Lakeworth](https://vircadia.com/vision/)                                                            | [Eric Schirtzinger](https://github.com/eschirtz)                                                               | [Karim Hossenbux](https://github.com/karimhossenbux)                                                         | [Decentralized Justice](https://github.com/DecentralizeJustice)                                                           |

## Past Supporters

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