Vue.jsでアプリを作って、GitHub Pagesでデプロイする:Vue.js Step by Step

commits6 min read読了の目安(約5600字

Vue.jsは、フロントエンド開発フレームワークです。2020年9月に、Vue 3.0が公開されました。

この記事では、Vue.jsを簡単なところから使い始めて、徐々に本格的に使う手順を記録していきます。まずは、Vue.jsの導入。Vue.jsを使い始めて、簡単なWebアプリをつくって、GitHub Pagesにデプロイするところまでやります。

Vue.jsで何かを作ろうとするとき、その土台を爆速で用意できると思います。

Vue.jsとは

Vue.jsには、「Progressive Framework」という特徴があり、jQueryとか使っていた人が、段階的に導入していくことができます。

なので、最新のフロントエンド開発に初めて取り組む人に、いい感じだと思います。

というか、私がそうです。

学習の流れ

私ごときが言うのもなんですが、Vue.jsを学習するにはときに、大事なポイントが2つあると思います。

1. 段階的導入を理解する

まずは、前出の「Progressive Framework」です。図のように段階的に導入していくことができます。Vue.jsの機能は、この段階に合わせて展開されています。

./images/install_vuejs/progressive_framework.png
Vue.js : The Progressive Framework by Evan You ※日本語注釈は筆者による

たとえば、最初の宣言的レンダリング(Declative Rendering)は、jQueryのような、HTMLのタグとJavatScriptの変数を1対1で対応づけるといった使い方に対応しています。このあたりは、Vue.js Progressive Framework というQiitaの記事が詳しく解説しています。

チュートリアルもこの段階に従っているので、これを理解していると、いま自分がどの段階にいるのか把握しやすいと思います。

2. Vue CLI を使う

もうひとつはのポイントは、早い段階でビルドシステムを使ったほうが分かりやすいということです。

Vue.jsは、それなりに機能が多いので、段階を追って使っていくと、なかなか使いやすい感じになりません。そこで、早い段階からビルドシステムを活用できるよう、Vue CLIを使ったほうがいいと思いました。このツールから、Webpackやbrowserifyが利用できますし、各種ライブラリも組み込みできます。

Vue CLIでつくったアプリケーションのひな型に、段階的に機能を追加していく。というのが、学習するうえで分かりやすいと思います。

ただ、Vue CLIは、Vue.jsとは別プロジェクトになっているみたいなので、Vue.jsの公式サイトやチュートリアルだけ見ていると、あまり情報がありません。Vue CLI の公式サイトを見るといいと思います。

Vue.jsのチュートリアルをやる

Vue.jsは、既存のWebサイトに組み込んで使うことができます。これが、一番試しやすいでしょう。公式チュートリアルをやると、基本的なコードの書き方を体験できると思います。ブラウザのなかで実行できるので、お手軽です。

Vue-CLIで、アプリケーションを作成する

次は、Vue CLIを使って、Vue.jsによるWebアプリケーションを作ります。

vue-cliをインストールする

これには、Vue-CLIを使います。

インストールします。

$ npm install -g @vue/cli
$ vue --version

vue-cliで、アプリケーションを作成する

アプリケーションを作成します。

$ vue create vue-app

たったこれだけ。

どの環境で作るか、メニュー形式で選択できるので、順番に答えていきます。最初は、デフォルトの選択肢を選べばいいんじゃないかな。

動作確認

できたアプリケーションをローカル環境で起動してみます。

$ cd vue-app
$ yarn serve
|
| App running at:
| - Local:   http://localhost:8080/
| - Network: http://192.168.1.4:8080/
|
| Note that the development build is not optimized.
| To create a production build, run yarn build.

ブラウザで http://localhost:8080/ にアクセスすると、こんなふうに表示されます。

./images/install_vuejs/first_app.png

vue-app ディレクトリは、GitHub にリポジトリを作って格納しておきましょう。

双方向バインディング

先ほどの公式サイトのチュートリアルにもあった、双方向バインディングをやってみましょう。ユーザー入力の制御の2番目の例のように、フォームの入力内容をテキストに反映します。

これは、/src/components/HelloWorld.vueを次のように修正します。ここでは"<h1>{{ msg }}</h1>"の下に、"<input v-model="msg" />"を追加しています。

/src/components/HelloWorld.vue
<template>
  <div class="hello">
    <h1>{{ msg }}</h1>
    <input v-model="msg" />
    <p>
      For a guide and recipes on how to configure / customize this project,<br>
      check out the
      <a href="https://cli.vuejs.org" target="_blank" rel="noopener">vue-cli documentation</a>.
    </p>
// ...

これで、ローカル環境で入力フォームのテキストを修正すると、すぐ上の見出しに反映されます。

./images/install_vuejs/vue_example.png

GitHub Pagesでデプロイする

では、Webアプリを静的サイトとして生成して、GitHub Pagesで公開してみましょう。GitHub Pagesには、個人のユーザーアカウントにひもづくページと、リポジトリにひもづくページがあります。今回は、リポジトリに対して作成します。

ビルドする

GitHub Pagesは、docsディレクトリか、gh-pagesブランチのファイルを出力します。今回は、docsディレクトリの内容を表示します。そこで、リポジトリのホームディレクトリに、vue.config.js というファイルを作成して、次のように書き込みます。

vue.config.js
module.exports = {
  outputDir: 'docs',
  assetsDir: './',
  publicPath: './',
}

つぎに、表示するファイルをビルドします。

$ yarn build
| DONE  Compiled successfully in 22541ms                                                                         20:06:29
| 
|  File                                 Size                                   Gzipped
|
| docs\js\chunk-vendors.ff672a17.js    89.66 KiB                              32.14 KiB
| docs\js\app.225fd15b.js              4.58 KiB                               1.63 KiB
| docs\css\app.fb0c6e1c.css            0.33 KiB                               0.23 KiB
|
| Images and other types of assets omitted.
| 
| DONE  Build complete. The docs directory is ready to be deployed.
| INFO  Check out deployment instructions at https://cli.vuejs.org/guide/deployment.html
| 
| Done in 31.22s.

これで、docs ディレクトリに静的ファイルが生成されました。

GitHubに、docsディレクトリごとコミットします。

GitHub Pagesを設定する

  1. GitHubで、対象のリポジトリにアクセスする
  2. 上部の「Settings」をクリック
  3. Pagesタブを選択
  4. Source として、Masterブランチのdocs ディレクトリを選択する
  5. Save ボタンをクリック

./images/install_vuejs/github_pages_settings.png

公開したアプリ

これで、vue.jsで作成したアプリケーションを、GitHub Pagesで公開できました。

参考になるページ