electron-vue README

The project's README from github.com/SimulatedGREG/electron-vue. As one markdown file: README.md.


electron-vue

The boilerplate for making electron applications built with vue (pretty much what it sounds like).

forthebadge forthebadge forthebadge

js-standard-style

Build Status

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

*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.

# 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).

vue init simulatedgreg/electron-vue#1.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.

electron-vue (SimulatedGREG/electron-vue)

vue-cli
Searching Database…

15.4K ·GitHub
Electron-vue
archived
What is this?electron-vue is a boilerplate for building Electron desktop apps with Vue.js. It bundles vue-cli scaffolding, webpack with vue-loader, common Vue plugins, and packaging tools so you do not have to wire up an Electron+Vue app from scratch.
Is this a ready-made app or a project template?It is a project template used through vue-cli scaffolding, not a finished application; you generate your own app from it and then build on top.
How do I start a new project with this?Scaffold a new project through vue-cli using this repo as the template, then install dependencies (the project officially recommends yarn over npm).
What do I need installed before scaffolding a project?Node.js version 7 or higher is required, and Windows users additionally need extra native build tools to compile Electron and other native dependencies.
Is this still maintained?No, the repository is archived, so it no longer receives updates; it also only officially supports Vue 2 going forward since Vue 1 support was deprecated.
Can I target Windows, macOS, and Linux with the same scaffolded app?Yes, it packages cross-platform desktop builds through electron-packager or electron-builder, and can also produce a web build for browsers.
What Vue plugins are ready to use out of the box?The boilerplate comes with axios, vue-electron, vue-router, and vuex already wired in, plus vue-devtools and devtron for debugging during development.
What testing setup does it include?It ships with unit testing via Karma + Mocha and end-to-end testing via Spectron + Mocha, so testing is configured from the start rather than added later.
What real apps have been built with electron-vue?The README lists many community projects built on it, including the Markdown editor MarkText, the Pomodoro timer Pomotroid, and the browser Lulumi-browser.
Does it support hot reloading during development?Yes, it uses webpack and vue-loader with Hot Module Replacement, and automatically restarts the Electron main process when you edit it.
What are similar projects?electron-react-boilerplate, angular-seed, js-stack-from-scratch, YesPlayMusic, magnetW, electron-builder, BoostNote-Legacy, Lepton
Which topics is it in?vue-cli, end-to-end-testing, scaffolding, babel, es6, unit-testing, electron-app, boilerplate, webpack, electron, vue, testing
Creator
SimulatedGREG
Size
5.8 MB
Stars
15.4K
Updated
CommitApr 21
Age
10y
Commits · 90 Days