TL;DR
サンプルコードはGithubにあります。
今回、FirebaseとNuxt.jsを使ってSSR(サーバーサイドレンダリング)をサーバーレスで実現するところまで、動画を見ながら足りないところを補完して自分でまとめた手順を説明していきます。
Firebase公式動画はこちらです。
はじめに
Wataruです。カナダのバンクーバーというところでCivic Tech関連の小さな会社でソフトウェアデベロッパーとして働いています。
なぜカナダで働いているか、もし興味があったらnote書きましたので読んで頂けると嬉しいです。
仕事の半分以上はフロントエンドを担当しています。もちろん、PostgreSQLのトリガー書いたり、PerlでAPIを書くこともあるし、たまにNginx、DockerやJenkins Pipelineのメンテしたりもします。色々学べるのは楽しいですね。
弊社のような小さな会社では、フロントエンド担当やバックエンド担当は特に設けておらず、DevOps担当のデベロッパーもアプリ側のコードを触ったりすることがあります。
最近になってようやく脱jQueryを試みているのですが、フロントエンド担当で無くても直感的に理解ができるものを、という理由でVue.jsを使っています。
フレームワークに慣れていない人でも触れるフレームワーク。いいですよね。
今回はVue.jsに慣れているけどFirebaseに触ったことがない、触ってみたい、ということで、どうせなら、とNuxt.jsでFirebaseを触ってみることにしました。
Step 0: 参考
本記事を書くにあたって参考にした記事や動画です。
- Server-Side Render Vue Apps with Nuxt.js(Server-side Rendering with JavaScript Frameworks) (Firebase公式動画)
- Nuxt.jsとFirebaseでSPA×SSR×PWA×サーバーレスを実現する
- Nuxt.jsとFirebaseを組み合わせて爆速でWebアプリケーションを構築する by potato4d
上のリンクの動画をベースに、Firebase初心者向け（主に自分）のために書きました。英語版はこちら。itnext.ioに掲載されました！
Step 1: プロジェクト用のフォルダを作りましょう
$ # プロジェクト用のフォルダ(<proj>、任意に決めてください)を作って、そのフォルダの中へ移動。
$ mkdir <proj> && cd $_
Step 2: Nuxt.jsをインストールしてみましょう
$ # vue-cliとyarnをインストールします。
$ sudo npm i -g vue-cli yarn
$ # nuxt-community/starter-templateを元にsrcフォルダへNuxtアプリが自動設定されます。
$ vue init nuxt-community/starter-template src
$ # 質問への回答は全部デフォルトでいいかと思います。Enterを押し続けてください。
- ? Generate project in current directory?
- ? Project name
- ? Project description
- ? ? Author
$ # srcフォルダへ移動し、npmパッケージをインストールします。
$ cd src/ && yarn
何も分からなくても、これだけで初期プロジェクトの設定ができてしまいました。いい時代ですね。
Step 3: トップページを作ってみましょう
今回の手順ではトップページしか作りません。Nuxt.jsのトップページはsrc/pages/index.vueにあたります。
$ # srcフォルダにいることを確認してください。
$ # 動画ではHTTPリクエストにisomorphic-fetchを使っています。
$ # しかしNuxt.js公式がaxiosの使用を超勧めていますので長い物には巻かれます。
$ yarn add axios
$ # デフォルトのindex.vueの中身を消して、一から作ります。
$ echo '' > pages/index.vue && vi pages/index.vue
pages/index.vueはこんな感じです。https://nuxt-ssr.firebaseio.com/facts.json で得た結果をリストに表示。簡単ですね。
<template>
<ul>
<li v-for="(fact, factIdx) in facts" :key="factIdx">
{{ fact.text }}
</li>
</ul>
</template>
<script>
import axios from 'axios'
export default {
async asyncData() {
const res = await axios.get('https://nuxt-ssr.firebaseio.com/facts.json')
const facts = res.data
return { facts }
}
}
</script>
<style>
</style>
$ # nuxt.config.jsという設定ファイルを編集します。
$ vi nuxt.config.js
nuxt.config.jsのファイルの中の、buildの中に以下を追加してください。
publicPath: '/public/',
vendor: ['axios'],
extractCSS: true,
Step 4: localhostで確認してみましょう
インストールとトップページの編集しかしていないNuxt.js。これが本当に動くのか、localhostで確認してみましょう。
$ # srcフォルダにいることを確認してください。
$ # yarn devでdev webサーバを起動して、Nuxt.jsも起動させます。
$ yarn dev
http://localhost:3000 で起動したよ、というメッセージが出てくるので、ブラウザで開いて確認してください。
ページを開いて三行くらいリストアイテムが表示されていたら、おめでとうございます。Nuxtアプリが動いていることが確認できました。
Chromeの'View Page Source'でページのソースを確認してみると、サーバーサイドレンダリングされていることがわかりますね。
Step 5: Babelを使って古いブラウザーをサポートしておきましょう
昔話になりますが、日本で働いていた当時、IEのシェアがとても大きかったです。新しいJSで作られたアプリはIEのようなブラウザが対応できない可能性があります。
これを解決するためにBabelを使います。
$ # srcフォルダにいることを確認してください。
$ # babelプラグインをインストールします。
$ yarn add -D babel-plugin-module-resolver babel-plugin-transform-runtime babel-preset-es2015 babel-preset-stage-0
$ # nuxt.config.jsという設定ファイルを編集します。
$ vi nuxt.config.js
nuxt.config.jsにbabelプラグイン等を認識させるために、ファイルを編集します。buildの中に以下を追加してください。
babel: {
presets: [
'es2015',
'stage-0'
],
plugins: [
['transform-runtime', {
'polyfill': true,
'regenerator': true,
}]
],
},
また、同ファイルのvendorを以下のように更新してください。'babel-polyfill'を追加するだけです。
vendor: ['axios', 'babel-polyfill'],
再度ブラウザで確認してみましょう。
$ # srcフォルダにいることを確認してください。
$ # yarn devでdev webサーバを起動して、Nuxt.jsも起動させます。
$ yarn dev
http://localhost:3000 で起動したよ、というメッセージが出てくるので、ブラウザで開いて確認してください。先ほどと同じ結果が表示されるはずです。うまく行かなかった場合はpackage.jsonの各パッケージのバージョンを確認してみてください。[GitHub]
Step 6: Firebaseをインストールしてみましょう
ここからFirebaseをインストールしていきます。
$ # <proj>フォルダに移動します。
$ cd <proj>
$ # firebase-toolsをインストールします。
$ sudo npm i -g firebase-tools
$ # ここでユーザログインをします。firebase公式のチュートリアルに沿って操作しました。
$ firebase login
$ # Cloud Functionsを含め、初期設定を行います。
$ firebase init functions
$ # プロジェクトが無いと思うので[create a new project]を選択します。
- ? Select a default Firebase project for this directory:
$ # どの言語（JSかTS）を使いたいか聞かれます。以降の質問に対してはデフォルトで良いです。
- ? What language would you like to use to write Cloud Functions?
- ? Do you want to use ESLint to catch probable bugs and enforce style?
- ? Do you want to install dependencies with npm now?
https://console.firebase.google.com を開くよう指示が出ると思うので開きます。確かユーザー認証だったと思います。
$ # プロジェクトを選択できるよう追加します。
$ firebase use --add
Step 7: Cloud Functionsの設定をしてみましょう
Firebaseの機能であるCloud Functionsの設定をしてみましょう。Cloud FunctionsはSSRのために使います。サーバー側での仕事をこの機能に丸投げします。
$ # nuxtの設定ファイルを編集します。
$ vi src/nuxt.config.js
以下の一行をnuxt.config.jsのトップレベルに追加します。これでビルド先がfunctionsフォルダに設定されます。
buildDir: '../functions/nuxt',
次はfirebase init functionsのコマンドで作成されたfunctionsフォルダに移動して作業をしましょう。
$ # functonsフォルダに移動します。
$ cd functions
$ # package.jsonを編集します。
$ vi package.json
Cloud Functionsは2018年8月にnode 8に対応できるようになりました。node 8を有効にするため、"engines": { "node": "8" }をトップレベルに追加してください。
src/package.jsonにある全てのパッケージをコピペして追加してください。
$ # 追加したパッケージをインストールします。
$ yarn
$ # express をインストールします。
$ yarn add express
$ # srcフォルダに移動し、アプリをビルドし、functionsフォルダに戻ってきましょう。
$ cd ../src/ && yarn build && cd ../functions/
アプリのビルドによって、今まで無かったnuxtフォルダがfunctionsフォルダに作成されています。
Step 8: Cloud FunctionsでNuxt.jsを動かせるようにしましょう
上記までの手順でNuxt.jsのコードがfunctionsフォルダにコピーされました(symlink作っても良いと思いますが)。
Cloud Functionsはfunctionsフォルダのindex.jsを起点として動きます。index.jsを編集してみましょう。
$ # functionsフォルダにいることを確認してください。
$ echo '' > index.js && vi index.js
functions/index.jsはこんな感じになります。アプリがNuxtにリクエストを与えてページをレンダリングさせていますね。
const functions = require('firebase-functions')
const express = require('express')
const { Nuxt } = require('nuxt')
const app = express()
const config = {
dev: false,
buildDir: 'nuxt',
build: {
publicPath: '/public/'
}
}
const nuxt = new Nuxt(config)
function handleRequest(req, res) {
res.set('Cache-Control', 'public, max-age=600, s-maxage=1200')
nuxt.renderRoute('/').then(result => {
res.send(result.html)
}).catch(e => {
res.send(e)
})
}
app.get('*', handleRequest)
exports.nuxtApp = functions.https.onRequest(app)
Step 9: Firebase Hostingで静的アセットを配信できるようにしましょう
静的アセットを動的配信する理由はないので、Firebase Hostingを利用して静的配信しましょう。
$ # functionsフォルダにいることを確認してください。
$ # <proj>フォルダに移動します。
$ cd ../
$ firebase init hosting
$ # 質問に対する回答は全部デフォルトで良いです。
- ? What do you want to use as your public directory?
- ? Configure as a single-page app (rewrite all urls to /index.html)?
これでpublicフォルダが作成されました。このフォルダに静的アセットを置いていきます。
$ # ページは全てNuxt.jsがレンダリングするので、標準でできたファイルは消しましょう。
$ rm public/404.html public/index.html
$ # functions/nuxtからdistをpublic/assetsにコピーしましょう。
$ cp -R functions/nuxt/dist public/assets
$ # src/static/からもpublicにコピーしましょう。
$ cp -R src/static/* public
Step 10: Firebaseでページ表示してみましょう
いよいよアプリをFirebase上にデプロイしてみます。
$ # <proj>フォルダにいることを確認してください。
$ # firebase.json を編集します。
$ vi firebase.json
hostingの下にあるrewritesを以下のように編集します。これでfunctions/index.jsで作ったnuxtAppが実行されるようになります。
"rewrites": [
{
"source": "**",
"function": "nuxtApp"
}
]
まずはlocalhostで表示を確認してみましょう。
$ sudo firebase serve --only functons,hosting
functionsの準備ができるまで時間がかかるのですが、緑色のチェックがついたら http://localhost:5000 を開いてみましょう。先ほどの http://localhost:3000 はNuxt.jsの、http://localhost:5000 はFirebaseの設定したlocalhost portになります。
他のportを選択したい場合、firebase serve --only functons,hosting -p 5001のようにportを設定できるオプションもあります。
ページが表示されたら成功です。
...
しかし、ブラウザ上でコンソールを開いてみてください。"Uncaught SyntaxError"が表示されているかと思います。これを直していきましょう。
$ # <proj>フォルダにいることを確認してください。
$ # src/nuxt.config.jsを編集します。
$ vi src/nuxt.config.js
publicPathを/public/から/に変更してください。functions/index.jsにも同様に変更を加えます。
$ # <proj>フォルダにいることを確認してください。
$ vi functions/index.js
変更が終わったら、srcフォルダへ入って再度アプリをビルドしてみましょう。
$ # <proj>フォルダにいることを確認してください。
$ # srcフォルダへ移動してビルドをします。
$ cd src && yarn build
改めて、localhostで確認してみましょう。
$ # <proj>フォルダに移動して静的アセットをコピー
$ cd .. && cp -R functions/nuxt/dist/ public && cp -R src/static/* public
$ # localhostで実行
$ sudo firebase serve --only hosting,functions
ブラウザ上で http://localhost:5000 を開き、コンソールを見てみるとエラーが消えているはずです。エラーが消えていたらおめでとうございます。最後にデプロイをしましょう。
$ # <proj>フォルダにいることを確認してください。
$ firebase deploy
少し時間がかかります。"✔ Deploy complete!"のメッセージが表示されるまで待っててください。表示されたら"Hosting URL:"に書かれたURLを開いて見ましょう。
https://localhost:5000 で見たものと同じページが表示されたら成功です。お疲れ様でした。
おわりに
無事にデプロイできたことを祈っています。
この手順で複雑なことをやっている訳ではありませんが、SSR+サーバーレスがこんなに簡単に作れてしまうのは驚きですね。Nuxt.jsとFirebase。無料で手早くサービスが作れることから、ハッカソン、MVP(Minimal Viable Product)なサービス開発や初期ステージでのイテレーションで役に立ちそうですね。私自身、Firebase初心者ですが、これから楽しんでいけたらと思っています。
読んでいただきありがとうございました。