next.js/examples/with-firebase-hosting

With Firebase Hosting example

How to use

Using create-next-app

Execute create-next-app with Yarn or npx to bootstrap the example:

npx create-next-app --example with-firebase-hosting with-firebase-hosting-app
# or
yarn create next-app --example with-firebase-hosting with-firebase-hosting-app

Download manually

Download the example:

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

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/<projectId>
• update the .firebaserc default project ID to the newly created project
• login to the Firebase CLI tool with firebase login

Install Project

npm install

Run Next.js development:

npm run dev

Run Firebase locally for testing:

npm run serve

Deploy it to the cloud with Firebase:

npm run deploy

Clean dist folder

npm run clean

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.

If you're having issues, feel free to tag @jthegedus in the issue you create on the next.js repo

Important

• 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.
• Specifying "engines": {"node": "8"} in the package.json is required for firebase functions to be deployed on Node 8 rather than Node 6 (Firebase Blog Announcement) . This is matched in src/functions/.babelrc so that babel output somewhat compacter and moderner code.

Customization

Next App and Next Server development are separated into two different folders:

• app - src/app/
• server - src/functions/

If you wish to modify any configuration of the Next App, you should only modify the contents of src/app.

For instance, the .babelrc in src/functions is used only to compile the Firebase Cloud Functions code, which is our the Next Server code. If you wish to customize the .babelrc for the Next App compilation, then you should create one at src/app/.babelrc and follow the customization guide.

_app.js

If using _app.js you may receive the following error on your deployed Cloud Function:

{ Error: Cannot find module '@babel/runtime/regenerator'...

Despite next.js having @babel/runtime as a dependency, you must install it as a dependency directly in this project.