SimulatedGREG /electron-vue

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.

★ 15,341⑂ 1,500👁 2⑃ 185● 938▤ 0
+0
日增长
15,341
stars
1,500
forks
2
watchers
185
prs
938
issues
0
releases

README

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 with vue-loader, electron-packager or electron-builder, and some of the most used plugins like vue-router, vuex, and so much more.

 Check out the detailed documentation here.

Things you'll find in this boilerplate...

 Basic project structure with a single package.json setup
 Detailed documentation
 Project scaffolding using vue-cli
 Ready to use Vue plugins \(axios, vue-electron, vue-router, vuex\)\
 Installed vue-devtools and devtron tools for development
 Ability to easily package your electron app using electron-packager or electron-builder\
 appveyor.yml and .travis.yml configurations for automated deployments with electron-builder\
 Ability to produce web output for browsers
 Handy NPM scripts
 Use of webpack and vue-loader with Hot Module Replacement
 Process restarting when working in main process
 HTML/CSS/JS pre-processor support with vue-loader
 ES6 with stage-0 by default
 Use of babili to remove the need of transpiling completely down to ES5
 ESLint \(with support for standard and airbnb-base\)\
 Unit Testing \(with Karma + Mocha\)\
 End-to-end Testing \(with Spectron + Mocha\)\

\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 node@^7 or higher required. electron-vue also officially recommends the yarn package manager as it handles dependencies much better and can help reduce final build size with yarn clean.

bash
 Install vue-cli and scaffold boilerplate
npm install -g vue-cli
vue init simulatedgreg/electron-vue my-project

 Install dependencies and run your app
cd my-project
yarn  or npm install
yarn run dev  or npm run dev


 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 vue@^1, so project structure, features, and documentation will reflect those changes (legacy documentation).

bash
vue init simulatedgreg/electron-vue1.0 my-project


 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.

 Surfbird: A Twitter client built on Electron and Vue
 Lulumi-browser: Lulumi-browser is a light weight browser coded with Vue.js 

Top issues

Snapshot: 2026-11-16T09:23:14Z · Data license Apache-2.0 · JSON