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 — это заготовка для создания настольных приложений на Electron с Vue.js. В неё входят основа проекта от vue-cli, webpack с vue-loader, популярные плагины Vue и инструменты для упаковки, поэтому не нужно настраивать приложение Electron + Vue с нуля.
Это готовое приложение или шаблон проекта?Это шаблон проекта, который используется через vue-cli, а не готовое приложение: вы создаёте на его основе собственное приложение и дорабатываете его.
Как мне начать новый проект с этим?Создайте новый проект через vue-cli, использовав этот репозиторий как шаблон, а затем установите зависимости (проект официально рекомендует yarn вместо npm).
Что мне нужно установить перед созданием проекта?Нужен Node.js версии 7 или выше. Пользователям Windows также требуются дополнительные инструменты для сборки нативного кода, чтобы скомпилировать Electron и другие нативные зависимости.
Этот проект ещё поддерживается?Нет, репозиторий находится в архиве, поэтому обновления больше не выходят. Кроме того, официально поддерживается только Vue 2, так как поддержка Vue 1 объявлена устаревшей.
Могу ли я собрать одно и то же приложение для Windows, macOS и Linux?Да, он создаёт кроссплатформенные десктопные сборки через electron-packager или electron-builder, а также может собрать веб-версию для браузеров.
Какие плагины Vue уже готовы к использованию?В заготовку уже встроены axios, vue-electron, vue-router и vuex, а также vue-devtools и devtron для отладки во время разработки.
Какое тестирование в него входит?В комплекте есть модульное тестирование через Karma + Mocha и сквозное (end-to-end) тестирование через 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