next.js/examples/with-firebase-hosting/README.md

With Firebase Hosting example

How to use

Download the example or clone the repo:

curl https://codeload.github.com/zeit/next.js/tar.gz/master | tar -xz --strip=2 next.js-master/examples/with-firebase-hosting
cd with-firebase-hosting

It is recommended to use a package manager that uses a lockfile and caching for faster dev/test cycles:

• Yarn
• npm5.1.x
• pnpm

Set up firebase:

• install Firebase Tools: npm i -g firebase-tools
• create a project through the firebase web console
• grab the projects ID from the web consoles URL: https://console.firebase.google.com/project/
• update the .firebaserc default project ID to the newly created project

Install project:

npm install

Run Next.js development:

npm run next

Run Firebase locally for testing:

npm run serve

Deploy it to the cloud with Firebase:

npm run deploy

The idea behind the example

The goal is to host the Next.js app on Firebase Cloud Functions with Firebase Hosting rewrite rules so our app is served from our Firebase Hosting URL. Each individual page bundle is served in a new call to the Cloud Function which performs the initial server render.

This is based off of the work at https://github.com/geovanisouza92/serverless-firebase & https://github.com/jthegedus/firebase-functions-next-example as described here.

Important / Caveats

• The empty placeholder.html file is so Firebase Hosting does not error on an empty public/ folder and still hosts at the Firebase project URL.
• firebase.json outlines the catchall rewrite rule for our Cloud Function.
• Testing on Firebase locally requires a complete build of the Next.js app. npm run serve handles everything required.
• Any npm modules dependencies used in the Next.js app (app/ folder) must also be installed as dependencies for the Cloud Functions project (functions folder).