ccba / 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.

The boilerplate for making electron apps 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 more.

Check out the documentation here.

Things you'll find in this boilerplate...

• Support for both Vue.js at 2.x.x and 1.x.x
• Basic project structure
• Detailed documentation
• Project scaffolding using vue-cli
• Ready to use Vue plugins (vue-electron, vue-resource, vue-router, vuex)*
• Installed vue-devtools and devtron tools for development
• Ability to easily package your electron app using electron-packager or electron-builder*
• Handy NPM scripts
• Use of webpack and vue-loader with Hot Module Replacement
• HTML/CSS/JS pre-processor support with vue-loader
• ES6 with stage-0 by default
• 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. Certain dependencies and scripts use ES6 specific features so the use of node@^6.5.0 or higher is recommended.

# 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
npm install
npm run dev

Wanting to use Vue 1?

Just point to the 1.0 branch. Please note that electron-vue has officially deprecated vue@^1 and documentation reflects those changes. Use the legacy documentation if you are using Vue 1.

vue init simulatedgreg/electron-vue#1.0 my-project

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.

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.

Future Plans

Be up to date with new features and improvements by checking on the GitHub Project.

Contributing

Wanting to submit a pull request? Make sure to read this first.