UNPKG

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
# 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: [![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) **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 | [![Yves Hoppe](https://avatars1.githubusercontent.com/u/897638?s=64&v=4)](https://github.com/yvesh) | [![Andrew LeTourneau](https://avatars2.githubusercontent.com/u/2807807?s=64&v=4)](https://github.com/centerorbit) | [![Mary-Tyler-Moore](https://avatars2.githubusercontent.com/u/46167401?s=64&v=4)](https://github.com/Mary-Tyler-Moore) | [![Mitch Dennet](https://avatars2.githubusercontent.com/u/16268619?s=64&v=4)](https://github.com/mitchdennett) | [![Kasen IO](https://avatars0.githubusercontent.com/u/52365539?s=64)](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) |