Udemy 6. Heroku.ymlを使ったDockerデプロイ #04
2020年06月25日に公開

Dockerfile解説編。Docker環境のNuxt.jsをHerokuにデプロイする(1/2)

今回達成すること

Nuxt.jsをHerokuにデプロイするために、Dockerfileとheroku.ymlを編集します。

この記事を通してNuxt.jsのデプロイに必要な知識を習得します。

作業に入る前に全体のデプロイ手順を確認しておきましょう。


  1. Nuxt.jsのDockerfileに本番用のコマンドを追記する(今回)
  2. Nuxt.js用heroku.ymlの作成(今回)
  3. Herokuアプリケーションの作成
  4. Nuxt.jsアプリをHerokuにpushする
  5. RailsにAPIドメインをセットする

※ この記事では主にNuxt.js(frontディレクトリ内)のファイルを編集します。

Nuxt.jsのDockerfileに本番用コマンドを追加する

「front」直下にあるDockerfileを、本番環境用に編集していきます。

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 yarn install

COPY . .

RUN yarn run build
# ここまで

EXPOSE ${CONTAINER_PORT}

  • NPM_CONFIG_PRODUCTION=false … (後述)

  • COPY package*.json ./ … packageから始まる全てのファイルをワークディレクトリ 直下にコピー。

  • RUN yarn install … パッケージをインストール。package.jsonをコピーした後で実行する。

  • COPY . . … その他のファイルを全てコピー。

  • RUN yarn run build … (後述)

Nuxt.jsをHerokuにデプロイする場合の環境変数

Nuxt.jsをHerokuにデプロイする場合、3つの環境変数を必要とします。

  1. HOST=0.0.0.0 … (必須)Dockerfileに記述済みのため追記の必要なし。
  2. NODE_ENV=production … (必須)Herokuがデフォルトで設定するため、追記の必要なし。
  3. NPM_CONFIG_PRODUCTION=false (任意)パッケージのインストールを操作するフラグ。今回追記。

NPM_CONFIG_PRODUCTION=falseとは何か

このNPM_CONFIG_PRODUCTION=falseとは何なのか? 挙動について説明します。

Herokuのデフォルトの挙動

Node.jsのアプリをデプロイする場合、Herokuはpackege.jsonに書かれた全てのパッケージをインストールします。

そしてビルドを完了したのちにdevDependenciesに書かれたパッケージを削除し、デプロイを実行します。

問題点

既にインストールされている@nuxtjs/eslint-configや、後でインストールする@nuxtjs/vuetifyなど、devDependenciesに書かれたモジュールが無いよ。とエラーを吐くことがあります。

対応策

2つあります。

  1. nuxt.config.jsの設定を開発・本番で切り替えるよう書き換えたり、パッケージをdependenciesにインストールする。
  2. NPM_CONFIG_PRODUCTION=falseの環境変数を設定する。

NPM_CONFIG_PRODUCTION=falseの挙動

この環境変数がfalseの場合は、devDependenciesのパッケージを削除しません。

そのため、NPM_CONFIG_PRODUCTION=falseを設定しています。


ちなみにtrueの場合は、そもそも全てのパッケージのインストールを行わず、dependenciesだけインストールします。

参考 Heroku Node.jsのサポート - Heroku

RUN yarn run buildは何をしているのか?

上記Dockerfileで記述したRUN yarn run buildは、yarn run buildを実行するようRUN命令で指定しています。

yarn run buildは、package.jsonのbuildスクリプトを実行しています。

front/package.json
"scripts": {
  "dev": "nuxt",
  "build": "nuxt build",  // ←ココ
  "start": "nuxt start",
  "generate": "nuxt generate",
  "lint": "eslint --ext .js,.vue --ignore-path .gitignore ."
},

つまりyarn run buildを実行すると、nuxt buildが実行されているのですね。

このnuxt buildは、Nuxt.jsをWebpackでビルド(構築)して、jsとcssをHeroku向けにミニファイルにしています。

これによりHerokuにもNuxt.jsアプリを表示することができるのです。

Nuxt.js用のheroku.ymlを作成する

「front」ディレクトリ直下にheroku.ymlを作成します。

まずは移動しましょう。

api $ cd ../front

heroku.ymlを作成します。

front $ touch heroku.yml

作成したファイルを開いてこのように編集します。

front/heroku.yml
build:
  docker:
    web: Dockerfile
  config:
    WORKDIR: app
    API_URL: "https://<前回作成したRailsアプリの名前>.herokuapp.com"
run:
  web: yarn run start
  • build.docker, configこちらの記事で説明しています。
  • yarn run start … Nuxt.jsの本番環境での起動コマンド。

Nuxt.jsの起動コマンド

Nuxt.jsは、環境によって起動コマンドが変わります。

  • 開発環境 … docker-compose.ymlでyarn run devを実行してNuxt.jsを起動。
  • 本番環境 … heroku.ymlでyarn run startを実行してNuxt.jsを起動。

この本番環境用のyarn run startコマンドは、実行前にnuxt buildを実行する必要があります。

そのためDockerfileにyarn run buildを追記したのです。

GitHubにpushしとく

以上で作業は終了です。

ここまでの変更をpushしておきましょう。

front $ git add -A
front $ git commit -m "edit_Dockerfile&add_heroku.yml"
front $ git push

まとめ

今回は、Dockerfileとheroku.ymlをHerokuデプロイ用に編集していきました。

コードのコピペだけではなく、意味を理解することが大切です。

これを続けていれば、いつの間にかネットの情報が自分の知識になりますよ。

次回~

次回はNuxt.jsのデプロイを完了し、インターネット上に"Hello"を返すAPIアプリケーションを表示させましょう!

▶︎ 次の記事へ。(👇にあるよ)

▷ また今後。(ブックマークしとく)

あなたの力になれること
私自身が独学でプログラミングを勉強してきたので、一人で学び続ける苦しみは痛いほど分かります。そこで、当時の私がこんなのあったら良いのにな、と思っていたサービスを立ち上げました。周りに質問できる人がいない、答えの調べ方が分からない、ここを聞きたいだけなのにスクールは高額すぎる...。そんな方に向けた単発・短期間メンターサービスを行っています。下のサービスへお進みください。
独学プログラマのサービス
次の記事はこちら
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)
新着
SPA開発
ブログ構築
小ネタ集