vue で構築された electron アプリケーションを作成するためのボイラープレートです(名前から分かるように)。
概要
このプロジェクトは vue を使用した electron アプリケーションの手動セットアップをなくすことを目標としています。electron-vue はスキャフォールディングのために vue-cli
、 vue-loader
と webpack
、 electron-packager
または electron-builder
、 vue-router
や vuex
などの最も使われているプラグインを使用します。
ドキュメントは こちらを確認してください。
このボイラープレートで見つけることができるもの...
- 単一の
package.json
セットアップによる基本的なプロジェクト構造 - 詳細なドキュメント
- vue-cli を使用したプロジェクトスキャフォールディング
- Vue プラグイン (axios, vue-electron, vue-router, vuex)を使用する準備ができています*
- 開発のために vue-devtools や devtron ツールのインストール
- electron-packager や electron-builder を使用して簡単にアプリケーションをパッケージングする機能*
- electron-builder による自動デプロイのための
appveyor.yml
と.travis.yml
の設定* - ブラウザ用の Web 出力を生成する機能
- 便利な NPM scripts
- Hot Module Replacement を伴う webpack と vue-loader の使用
- electron の
main
プロセスで動いているプロセスの再起動 - vue-loader による HTML/CSS/JS プリプロセッサのサポート
- ES6 のデフォルトは
stage-0
です - ES5 へトランスパイルする必要をなくすために
babili
の使用 - ESLint (
standard
とairbnb-base
スタイルのサポート)* - (Karma と Mocha を使用した)ユニットテスト*
- (Spectron と Mocha を使用した)エンドツーエンドテスト*
*の箇所は vue-cli
のスキャフォールディング中にカスタマイズ可能です
はじめに
このボイラープレートは vue-cli
のテンプレートとして作成され、スキャフォールディングされたアプリケーションをカスタマイズするためのオプションが含まれています。node@^7
かそれ以上のバージョンを使用する必要があります。electron-vue はパッケージマネージャの yarn
を公式に推奨しています。依存関係をよりよく処理し、yarn clean
により最終的なビルドサイズを減らすことができます。
# vue-cli をインストールしボイラープレートをスキャフォールディングします
npm install -g vue-cli
vue init simulatedgreg/electron-vue my-project
# 依存関係をインストールし、アプリケーションを実行します
cd my-project
yarn # or npm install
yarn run dev # or npm run dev
Windows ユーザーですか?
Windows ユーザーのための注意を確認し、electron や他の依存関係で必要なビルドツールが全てあることを確認してください。
Vue 1 を使いたいですか?
1.0
ブランチを参照してください。electron-vue は vue@^1
の使用を公式に推奨していないため、プロジェクトの構造、機能やドキュメントは これらの変更を反映していることに注意してください(旧版のドキュメント)。
vue init simulatedgreg/electron-vue#1.0 my-project
次のステップ
ドキュメント を確認してください。こちらから設定、プロジェクト構造、アプリケーションのビルドに関する有益な情報を得ることができます。便利な FAQ セクションもあります。
electron-vue で作られたもの
electron-vue で作られたいくつかの素晴らしいプロジェクトを見てみましょう。自身のプロジェクトをリストに追加したいですか?遠慮なくプルリクエストを送ってください。
- Surfbird: Electron と Vue で作られた Twitter クライアント
- Lulumi-browser: Lulumi-browser は Vue.js 2 と Electron でコーディングされた軽量なブラウザです。
- Space-Snake: Electron と Vue.js で作られたデスクトップゲーム。
- Forrest: npm scripts デスクトップクライアント
- miikun: シンプルなマークダウンエディター
- Dakika: 議事録を簡単に取ることができるアプリケーション
- Dynamoc: Dynamoc は dynamodb-local、 dynalite と AWS dynamodb のための GUI クライアントです
- Dockeron: Docker のために Electron と Vue.js で作られた dockeron プロジェクト
- Easysubs: 字幕を早く簡単な方法でダウンロードする
- Data-curator:利用可能な公開データを共有します。