An Electron & Vue.js quick start boilerplate with vue-cli scaffolding, common Vue plugins, electron-packager/electron-builder, unit/e2e testing, vue-devtools, and webpack.
An Electron & Vue.js quick start boilerplate with vue-cli scaffolding, common Vue plugins, electron-packager/electron-builder, unit/e2e testing, vue-devtools, and webpack.
SimulatedGREG/electron-vue
The boilerplate for making electron applications built with vue (pretty much what it sounds like).
Overview
The aim of this project is to remove the need of manually setting up electron apps using vue. electron-vue takes advantage of
vue-cli
for scaffolding,webpack
withvue-loader
,electron-packager
orelectron-builder
, and some of the most used plugins likevue-router
,vuex
, and so much more.Check out the detailed documentation here.
Things you'll find in this boilerplate...
package.json
setupappveyor.yml
and.travis.yml
configurations for automated deployments with electron-builder*stage-0
by defaultbabili
to remove the need of transpiling completely down to ES5standard
andairbnb-base
)**Customizable during vue-cli scaffolding
Getting Started
This boilerplate was built as a template for vue-cli and includes options to customize your final scaffolded app. The use of
[email protected]^7
or higher required. electron-vue also officially recommends theyarn
package manager as it handles dependencies much better and can help reduce final build size withyarn clean
.Are you a Windows User?
Make sure to check out A Note for Windows Users to make sure you have all the necessary build tools needed for electron and other dependencies.
Wanting to use Vue 1?
Just point to the
1.0
branch. Please note that electron-vue has officially deprecated the usage of[email protected]^1
, so project structure, features, and documentation will reflect those changes (legacy documentation).Next Steps
Make sure to take a look at the documentation. Here you will find useful information about configuration, project structure, and building your app. There's also a handy FAQs section.
Made with electron-vue
Take a look at some of the amazing projects built with electron-vue. Want to have your own project listed? Feel free add your project to the bottom of the list below then submit a pull request.