Udemy 9. Nuxt.jsフロント開発事前準備 #02
2020年07月21日に公開

Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する

このチャプターで達成すること

チャプター「Nuxt.jsフロント開発事前準備」ではNuxt.jsのCSS環境を整えていきます。

具体的にはVuetifyの導入とカスタマイズ方法、Nuxt.jsメインCSSファイルの設定方法を解説します。

このチャプターを通してVuetifyとCSS周りの知識を深めましょう。

今回達成すること

Docker環境のNuxt.jsにCSSフレームワークのVuetifyを導入します。


現状のDockerfileでは、Vuetifyのインストール時にエラーが出ます。

これはAlpineのNode.jsイメージに依存関係が存在しないために起こるエラーです。

この依存関係のインストール方法についても解説します。

ブランチを切っておく

作業に入る前にブランチを切っておきましょう。

root $ cd front
front $ git checkout -b 20200719_add_vuetify
front $ git branch

...
* 20200719_add_vuetify

確認が取れたら「root」ディレクトリに戻りましょう。

front $ cd ..
root $

yarnでVuetifyをインストールすると…

Nuxt.jsアプリの作成時にはVuetifyを導入しませんでした。(色々なファイルが勝手に作られるため)

そこで「@nuxtjs/vuetify」モジュールでVuetifyを導入します。

ただ$ yarn addコマンドでインストールすると…。(実行しないで)

root $ docker-compose run --rm front yarn add --dev @nuxtjs/vuetify

おや、大量のエラーが…

大量のエラーが出ましたね。

...
gyp ERR! find Python **********************************************************
gyp ERR! find Python You need to install the latest version of Python.
gyp ERR! find Python Node-gyp should be able to find and use Python. If not,
gyp ERR! find Python you can try one of the following options:
gyp ERR! find Python - Use the switch --python="/path/to/pythonexecutable"
gyp ERR! find Python   (accepted by both node-gyp and npm)
gyp ERR! find Python - Set the environment variable PYTHON
gyp ERR! find Python - Set the npm configuration variable python:
gyp ERR! find Python   npm config set python "/path/to/pythonexecutable"
gyp ERR! find Python For more information consult the documentation at:
gyp ERR! find Python https://github.com/nodejs/node-gyp#installation
gyp ERR! find Python **********************************************************
...

大丈夫、計画通りです。

エラーの原因

このエラーは「node-gyp」の依存関係が無いために起こったエラーです。

「node-gyp」とは、Node.jsのモジュールをコンパイルするコマンドラインツールです。

恐らく内部で「node-gyp」のコマンドラインが正常に動かなかったのでしょう。

エラー解決を探る

「node-gyp」の公式サイトを確認します。

依存関係にはmakepythonが必要と書かれています。

オペレーティングシステムに応じて、次のものをインストールする必要があります。

Unixの場合

  • Python v2.7, v3.5, v3.6, v3.7, or v3.8
  • make
  • A proper C/C++ compiler toolchain, like GCC

引用 node-gyp - DitHub

また、ベースイメージのalpine-nodeには下記のような記載があります。

ネイティブの依存関係がある場合は、追加のツールが必要になります。

RUN apk add --no-cache make gcc g++ python

引用 alpine-node - Github

結論

以上のことからmake gcc g++ pythonの4つの依存関係をインストールし、「node-gyp」のエラーに対応します。

Dockerイメージに依存関係をインストールする

それではNode.jsのDockerイメージにmake gcc g++ pythonをインストールします。

「front」ディレクトリのDockerfileapk addコマンドを追加しましょう。

front/Dockerfile
FROM node:14.4.0-alpine

ARG WORKDIR
ARG CONTAINER_PORT
ARG API_URL

ENV HOME=/${WORKDIR} \
    LANG=C.UTF-8 \
    TZ=Asia/Tokyo \
    HOST=0.0.0.0 \
    API_URL=${API_URL} \
    NPM_CONFIG_PRODUCTION=false

# ENV check
RUN echo ${HOME}
RUN echo ${CONTAINER_PORT}
RUN echo ${API_URL}

WORKDIR ${HOME}

COPY package*.json ./

# 追加
RUN apk update && \
    apk upgrade && \
    apk add --no-cache make gcc g++ python && \
    # yarn installの記載場所を移動
    yarn install
# ここまで

COPY . .

RUN yarn run build

EXPOSE ${CONTAINER_PORT}

apkコマンドの解説はこちらの記事をご覧ください。

Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)

イメージをビルドしましょう。

root $ docker-compose build front

適度にDockerイメージの<none>タグを一括削除してください。(任意)

root $ docker rmi $(docker images -f 'dangling=true' -q) -f

@nuxtjs/vuetityをインストールする

「@nuxtjs/vuetity」モジュールのインストールを実行します。

root $ docker-compose run --rm front yarn add --dev @nuxtjs/vuetify

公式のインストール方法に従い、devDependenciesにインストールします。

インストールを確認しておきましょう。

root $ docker-compose run --rm front yarn list --pattern @nuxtjs/vuetify

...
└─ @nuxtjs/vuetify@1.11.2

うまくいきました。

@nuxtjs/vuetifyのセットアップ

インストールしただけでは「@nuxtjs/vuetify」は使えません。

モジュールをNuxt.jsに登録する必要があります。

devDependenciesでインストールしたので、nuxt.config.jsbuildModulesに追加します。

front/nuxt.config.js
...
buildModules: [
  ...
  // 追加
  // Doc: https://www.npmjs.com/package/@nuxtjs/vuetify
  '@nuxtjs/vuetify'
],

もう一つ、忘れてはいけない初期設定があります。

Vuetifyのコンポーネントを動かすには<v-app>タグで囲まれていなければなりません。

そこで全体を<v-app>で囲むよう、Nuxt.jsのレイアウトファイルにタグを仕込みます。

front/layouts/default.vue
<template>
  <v-app>
    <nuxt />
  </v-app>
</template>

ついでにスタイルのコードは全て削除しました。

Vuetifyにオリジナルカラーを追加する

自分だけの色合いを設定しましょう。

Vuetifyのオリジナルカラーの設定はnuxt.config.jsから行います。

front/nuxt.config.js
...
// 追加
vuetify: {
  theme: {
    themes: {
      light: {
        primary: '4080BE',
        info: '4FC1E9',
        success: '44D69E',
        warning: 'FEB65E',
        error: 'FB8678',
        background: 'f6f6f4'
      }
    }
  }
},
// ここまで

build: {
}

ちょっとワンポイント

今回はSPA開発なのでSEO対策を気に掛ける必要はありません。

しかしブログなどUniversalモードの場合は、コントラストを考えてカラーを設定しなければサイト評価が下がります。(若干ではありますが)

ちなみに上記のカラー設定はSEO的にアウトです。

例えばprimary# 0053A3まで濃くすればコントラストが正常と判断されます。

コントラストの判定は下記URLから行うことができます。

https://dequeuniversity.com/rules/axe/3.2/color-contrast

Vuetifyのコンポーネントを使ってみよう

トップページのindex.vueを、Vuetifyコンポーネントを使って編集します。

template内をまるっと書き換えましょう。

あとはスクリプトにuserKeyscolorsを用意してください。

最終的なindex.vueは下記のようになります。

front/pages/index.vue
<template>
  <v-container fluid>
    <v-card
      flat
      tile
      color="transparent"
    >
      <v-card-title>
        Usersテーブルの取得
      </v-card-title>
      <v-card-text>
        <v-simple-table dense>
          <template
            v-if="users.length"
            v-slot:default
          >
            <thead>
              <tr>
                <th
                  v-for="(key, i) in userKeys"
                  :key="`key-${i}`"
                >
                  {{ key }}
                </th>
              </tr>
            </thead>
            <tbody>
              <tr
                v-for="(user, i) in users"
                :key="`user-${i}`"
              >
                <td>{{ user.id }}</td>
                <td>{{ user.name }}</td>
                <td>{{ user.email }}</td>
                <td>{{ dateFormat(user.created_at) }}</td>
              </tr>
            </tbody>
          </template>
          <template v-else>
            ユーザーが存在しません
          </template>
        </v-simple-table>
      </v-card-text>
      <v-card-title>
        Vuetifyの導入(オリジナルカラーの確認)
      </v-card-title>
      <v-card-text>
        <v-btn
          v-for="(color, i) in colors"
          :key="`color-${i}`"
          :color="color"
          class="mr-2"
        >
          {{ color }}
        </v-btn>
      </v-card-text>
    </v-card>
  </v-container>
</template>

<script>
export default {
  async asyncData ({ $axios }) {
    let users = []
    await $axios.$get('/api/v1/users').then(res => (users = res))
    const userKeys = Object.keys(users[0] || {}) // 追加
    return { users, userKeys }
  },
  // data () 追加
  data () {
    return {
      colors: ['primary', 'info', 'success', 'warning', 'error', 'background']
    }
  },
  computed: {
    dateFormat () {
      return (date) => {
        const dateTimeFormat = new Intl.DateTimeFormat(
          'ja', { dateStyle: 'medium', timeStyle: 'short' }
        )
        return dateTimeFormat.format(new Date(date))
      }
    }
  }
}
</script>
  • Vuetifyの各プロパティ

    • fluid … コンテナ領域を画面いっぱいにします。付けない場合は画面は幅に合わせ自動調節します。
    • flat … 影を消して浮いている感じをなくします。
    • tile … カードの角がとんがります。デフォルトは少し丸い。
    • color="transparent" … カラーを透明に指定しています。デフォルトは白。
    • dense … テーブル表示をスリム(ミニ)にします。

コンテナを起動してブラウザで確認してみましょう。

root $ docker-compose up

2020-07-21 12-35-57

OK!完璧です。確認が取れたらコンテナを削除しておいてください。

以上でVuetifyの導入は完了です。

コミットしておく

「front」ディレクトリをコミットしておきます。

root $ cd front && git commit -am "vuetify_setup" && cd ..

次回は?

次回はVuetifyカスタムCSSを導入し、オリジナルブレイクポイントを追加します。

日本語の記事ではどこにも無い情報なので、是非ともお読みください。

どうぞ下の記事リストへ(↓GO💨)

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
1. このカテゴリーの歩き方 #01
【お知らせ】UdemyでRails × Nuxt.jsの動画を公開することになりました
1. このカテゴリーの歩き方 #02
【随時更新】このカテゴリーで作るアプリケーションの仕様書
1. このカテゴリーの歩き方 #03
【随時更新】このカテゴリーの歩き方
1. このカテゴリーの歩き方 #04
(Docker+Rails6+Nuxt.js+PostgreSQL)=>Heroku 環境構築~デプロイまでの手順書
2. Docker入門 #01
Docker for Macをインストールする手順
2. Docker入門 #02
分かるDocker解説。仮想環境・コンテナ・Dockerイメージ・Dockerfileとは何か?
2. Docker入門 #03
分かるDocker解説。DockerComposeとは何か?
3. Dockerを使ったRails+Nuxt.js環境構築 #01
【Docker+Rails6+Nuxt.js】今回作成するアプリの開発環境の全体像を知ろう
3. Dockerを使ったRails+Nuxt.js環境構築 #02
【MacOS】Homebrew経由でGitをインストールする方法
3. Dockerを使ったRails+Nuxt.js環境構築 #03
Rails6を動かすAlpineベースのDockerfileを作成する(AlpineLinuxとは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #04
Nuxt.jsを動かすAlpineベースのDockerfileを作成する(C.UTF-8とは何か)
3. Dockerを使ったRails+Nuxt.js環境構築 #05
.envファイルを使ったdocker-compose.ymlの環境変数設計
3. Dockerを使ったRails+Nuxt.js環境構築 #06
Rails6・Nuxt.js・PostgreSQLを動かすdocker-compose.ymlファイルを作成する
3. Dockerを使ったRails+Nuxt.js環境構築 #07
docker-compose.ymlを使ってRails6を構築する(PostgreSQLパスワード変更方法)
3. Dockerを使ったRails+Nuxt.js環境構築 #08
docker-compose.ymlを使ってNuxt.jsを構築する
4. 複数プロジェクトのGit管理 #01
複数プロジェクトで行うGit管理の全体像を理解しよう(Gitサブモジュール解説)
4. 複数プロジェクトのGit管理 #02
【Git】既存の子ディレクトリをサブモジュール管理に変更する手順
4. 複数プロジェクトのGit管理 #03
【GitHub】秘密鍵の生成・公開鍵を追加・SSH接続するまでを画像で分かりやすく
4. 複数プロジェクトのGit管理 #04
【GitHub】リモートリポジトリの追加・サブモジュールのリンク設定を行う
5. RailsAPI×Nuxt.js初めてのAPI通信 #01
【Rails6】"Hello" jsonを返すコントローラを作成する
5. RailsAPI×Nuxt.js初めてのAPI通信 #02
【Nxut.js】axiosの初期設定を行う(baseURL・browserBaseURLを解説)
5. RailsAPI×Nuxt.js初めてのAPI通信 #03
【Rails6】Gem rack-corsを導入してCORS設定を行う(オリジン・CORSとは何か)
6. Heroku.ymlを使ったDockerデプロイ #01
デプロイ準備。Herokuへ新規会員登録を行いHerokuCLIをインストールする
6. Heroku.ymlを使ったDockerデプロイ #02
heroku.yml解説編。Docker環境のRails6をHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #03
HerokuCLI-manifestのデプロイ解説編。Docker環境のRails6をHerokuにデプロイする(2/2)
6. Heroku.ymlを使ったDockerデプロイ #04
Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)
6. Heroku.ymlを使ったDockerデプロイ #05
デプロイ完結編。Docker環境のNuxt.jsをHerokuにデプロイする(2/2)
7. モデル開発事前準備 #01
【Rails6】application.rbの初期設定(タイムゾーン・I18n・Zeitwerk)
7. モデル開発事前準備 #02
【Rails6】モデル開発に必要なGemのインストールとHirb.enableの自動化
7. モデル開発事前準備 #03
【Docker+Rails】A server is already running. Check /tmp/pids/server.pidエラーの対応
7. モデル開発事前準備 #04
【Docker】<none>タグのイメージを一括削除する & Rails .gitignoreの編集
8. ユーザーモデル開発 #01
Railsユーザーモデル作成。テーブル設計・ユーザー認証設計を理解する
8. ユーザーモデル開発 #02
Railsユーザーモデルのバリデーション設定(has_secure_password解説)
8. ユーザーモデル開発 #03
Railsバリデーションエラーメッセージの日本語化(ja.yml設定方法)
8. ユーザーモデル開発 #04
EachValidatorクラスのカスタムバリデーション設定(Rails6/lib以下読込)
8. ユーザーモデル開発 #05
Rails環境ごとにSeedデータ切り替えるseeds.rbの書き方
8. ユーザーモデル開発 #06
Rails6から導入された並列テストを理解する
8. ユーザーモデル開発 #07
Railsユーザーモデルバリデーションテスティング(name/email/password)
8. ユーザーモデル開発 #08
Nuxt.jsからRailsのユーザーテーブルを取得しHerokuにデプロイする
9. Nuxt.jsフロント開発事前準備 #01
【Nuxt.js2.13超解説】バージョンアップ手順と6つの新機能+2つの変更点
9. Nuxt.jsフロント開発事前準備 #02
Docker AlpineベースのNode.js上で動くNuxt.jsにVuetifyを導入する
9. Nuxt.jsフロント開発事前準備 #03
VuetifyにカスタムCSSを導入してオリジナルブレイクポイントを作る
9. Nuxt.jsフロント開発事前準備 #04
Nuxt.jsにnuxt-i18nを導入して国際化に対応する
10. 認証アプリのレイアウト設計 #01
Nuxt.jsのレイアウト・ページ・コンポーネントの役割を理解しよう
10. 認証アプリのレイアウト設計 #02
ウェルカムページを構成するコンポーネントファイル群を作成しよう(1/4)
新着
10. 認証アプリのレイアウト設計 #03
ウェルカムページにアイキャッチ画像・アプリ名・メニューボタンを表示しよう(2/4)
新着
10. 認証アプリのレイアウト設計 #04
addEventListenerでスクロールを検知しツールバーの色を変化させよう(3/4)
新着
10. 認証アプリのレイアウト設計 #05
ウェルカムページをレスポンシブデザインに対応させよう(4/4)
新着
SPA開発
ブログ構築
小ネタ集