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)

Searching Database…

15.4K ·GitHub
Electron-vue
archived
这是什么？electron-vue 是一个用 Vue.js 开发 Electron 桌面应用的样板项目。它集成了 vue-cli 脚手架、带 vue-loader 的 webpack、常用的 Vue 插件和打包工具，省去了从零搭建 Electron+Vue 应用的步骤。
这是现成的应用还是项目模板？它是通过 vue-cli 脚手架使用的项目模板，并不是成品应用。你可以用它生成自己的应用，再在此基础上开发。
我该怎么用它开始一个新项目？使用本仓库作为模板，通过 vue-cli 生成新项目，然后安装依赖（项目官方推荐使用 yarn 而不是 npm）。
生成项目之前需要先安装什么？需要 Node.js 7 或更高版本。Windows 用户还需要额外的原生编译工具，用于编译 Electron 和其他原生依赖。
这个项目还在维护吗？不再维护。仓库已归档，不会再收到更新。另外，由于 Vue 1 的支持已被弃用，今后官方只支持 Vue 2。
同一个生成的应用能同时打包到 Windows、macOS 和 Linux 吗？可以。它可以通过 electron-packager 或 electron-builder 打包跨平台的桌面应用，也可以生成用于浏览器的网页版本。
有哪些 Vue 插件开箱即用？该样板已集成 axios、vue-electron、vue-router 和 vuex，开发调试时还可以使用 vue-devtools 和 devtron。
它包含哪些测试环境？它内置了单元测试（Karma + Mocha）和端到端测试（Spectron + Mocha），从一开始就配置好，无需后期再添加。
用 electron-vue 做过哪些真实应用？README 列出了许多基于它开发的社区项目，包括 Markdown 编辑器 MarkText、番茄钟计时器 Pomotroid 和浏览器 Lulumi-browser。
开发时支持热重载吗？支持。它使用 webpack 和 vue-loader 实现热模块替换（HMR），编辑 Electron 主进程代码时还会自动重启。
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