# vue-cli-plugin-electron-builder

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

Latest version **2.1.1** (published 2021-06-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install vue-cli-plugin-electron-builder
pnpm add vue-cli-plugin-electron-builder
yarn add vue-cli-plugin-electron-builder
bun add vue-cli-plugin-electron-builder
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.1 |
| Published | 2021-06-24 |
| First published | 2018-04-11 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 20 |
| Unpacked size | 374.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4073 |
| Author | Noah Klayman |
| Maintainers | nklayman |
| Keywords | electron, vue, cli, vue-cli, vue-cli-plugin, webpack, electron-builder, electron-webpack |

## Links

- npm: https://www.npmjs.com/package/vue-cli-plugin-electron-builder
- Repository: https://github.com/nklayman/vue-cli-plugin-electron-builder
- Homepage: https://nklayman.github.io/vue-cli-plugin-electron-builder/
- Funding: https://github.com/sponsors/nklayman
- npm.io page: https://npm.io/package/vue-cli-plugin-electron-builder

## Dependencies (20)

- [execa](https://npm.io/package/execa.md) ^5.0.0
- [yargs](https://npm.io/package/yargs.md) ^15.3.1
- [semver](https://npm.io/package/semver.md) ^7.3.2
- [split2](https://npm.io/package/split2.md) ^3.0.0
- [pumpify](https://npm.io/package/pumpify.md) ^2.0.1
- [webpack](https://npm.io/package/webpack.md) ^4.18.0
- [chokidar](https://npm.io/package/chokidar.md) ^3.0.2
- [fs-extra](https://npm.io/package/fs-extra.md) ^9.0.1
- [unzip-crx](https://npm.io/package/unzip-crx.md) ^0.2.0
- [portfinder](https://npm.io/package/portfinder.md) ^1.0.16
- [lodash.merge](https://npm.io/package/lodash.merge.md) ^4.6.1
- [through2-map](https://npm.io/package/through2-map.md) ^3.0.0
- [webpack-chain](https://npm.io/package/webpack-chain.md) ^6.0.0
- [webpack-merge](https://npm.io/package/webpack-merge.md) ^4.2.2
- [shebang-loader](https://npm.io/package/shebang-loader.md) ^0.0.1
- [through2-filter](https://npm.io/package/through2-filter.md) ^3.0.0
- [electron-builder](https://npm.io/package/electron-builder.md) ^22.2.0
- [@vue/cli-shared-utils](https://npm.io/package/@vue/cli-shared-utils.md) ^4.5.6
- [terser-webpack-plugin](https://npm.io/package/terser-webpack-plugin.md) ^3.0.3
- [friendly-errors-webpack-plugin](https://npm.io/package/friendly-errors-webpack-plugin.md) ^1.7.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 2.1.1 (latest) — 2021-06-24
- 3.0.0-alpha.4 (alpha) — 2022-01-22
- 2.0.0-beta.6 (beta) — 2020-04-04
- 3.0.0-alpha.3 — 2022-01-15
- 3.0.0-alpha.2 — 2022-01-15
- 3.0.0-alpha.1 — 2022-01-07
- 3.0.0-alpha.0 — 2022-01-03
- 2.1.0 — 2021-06-23
- 2.0.0 — 2021-05-09
- 2.0.0-rc.6 — 2021-02-02
- 2.0.0-rc.5 — 2020-10-29
- 2.0.0-rc.4 — 2020-06-29
- 2.0.0-rc.3 — 2020-06-24
- 2.0.0-rc.2 — 2020-06-13
- 2.0.0-rc.1 — 2020-05-31
- … 79 more at https://npm.io/package/vue-cli-plugin-electron-builder/versions

## README

# 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)                                                                |

---
_Source: https://npm.io/package/vue-cli-plugin-electron-builder · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
