Overview

The aim of this project is to simplify the setup of Electron apps using Vue. electron-vue leverages vue-cli for scaffolding, webpack with vue-loader, and popular plugins like vue-router and vuex. It also provides features like easy packaging of Electron apps, automated deployments with electron-builder, and support for web output.

Features

• 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 the main process
• HTML/CSS/JS pre-processor support with vue-loader
• ES6 with stage-0 by default
• Use of babili to remove the need for transpiling 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

Installation

1. Make sure you have Node@^7 or higher installed.
2. If you are a Windows user, check out “A Note for Windows Users” to ensure you have all the necessary build tools.
3. Install the yarn package manager (recommended for better dependency management and smaller build size with yarn clean).
4. Clone the electron-vue repository.
5. Follow the detailed documentation to configure and build your app.

Summary

Electron-vue is a project that aims to simplify the setup of Electron apps using Vue. It provides a boilerplate with a basic project structure, pre-installed Vue plugins and development tools, and the ability to easily package your app. With detailed documentation and support for customization, electron-vue is a convenient tool for developers using Electron and Vue.