msuchodolski / electron-vue

An Electron & Vue.js quick start boilerplate with vue-cli support

Fork, original here: SimulatedGREG/electron-vue

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 to setup electron apps using vue. Since vue can take advantage of module loaders like webpack, getting everything to play nicely can be a little tricky.

Check out the documentation here.

Things you'll find in this boilerplate...

• Support for both Vue.js at 1.x.x and 2.x.x (using next)*
• Basic project structure
• 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
• Handy NPM scripts
• Use of webpack and vue-loader for Hot Module Replacement
• HTML/CSS/JS pre-processor support with vue-loader
• ES6 with stage-0 by default
• ESLint (support for standard and airbnb-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.

# 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

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.

Contributing

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