History

Luis Alvarez D 4162e39696 Undo unrequired readme changes done to examples (#16831 ) Related to https://github.com/vercel/next.js/pull/16678#issuecomment-684962496		2020-09-03 19:11:58 +00:00
..
public	Update `with-firebase-hosting[-and-typescript]` examples (#11685 )	2020-05-02 00:56:40 -04:00
src	More redundant imports @ examples (#13190 )	2020-05-22 15:33:04 +00:00
.firebaserc	With Firebase Hosting Example (#2642 )	2017-07-26 07:52:49 +02:00
.gitignore	Added .gitignore to examples that are deployed to vercel (#15127 )	2020-07-16 10:52:23 -04:00
firebase.json	[Example] fix with-firebase-hosting (#16577 )	2020-08-29 22:17:16 -04:00
firebaseFunctions.js	Update `with-firebase-hosting[-and-typescript]` examples (#11685 )	2020-05-02 00:56:40 -04:00
package.json	Ensure all examples are MIT licensed (#16691 )	2020-08-29 22:32:35 -04:00
README.md	Undo unrequired readme changes done to examples (#16831 )	2020-09-03 19:11:58 +00:00

README.md

with Firebase Hosting 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.

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

Make sure that firebase is set up and you have the projectID

Install Firebase Tools: npm i -g firebase-tools
Create a project through the firebase web console
Login to the Firebase CLI tool with firebase login
Grab the projectID from firebase projects:list or the web consoles URL: https://console.firebase.google.com/project/<projectID>

How to use

Execute create-next-app with npm or Yarn 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

Important: Update .firebaserc and add your firebase project ID.

To run Firebase locally for testing:

npm run serve
# or
yarn serve

To deploy it to the cloud with Firebase:

npm run deploy
# or
yarn deploy

Typescript

To use Typescript, simply follow Typescript setup as normal (package.json scripts are already set).

i.e: npm install --save-dev typescript @types/react @types/node

Then you can create components and pages in .tsx or .ts

Only src/next.config.js and firebaseFunctions.js must remain in *.js format.

Good to know

firebase.json outlines the catchall rewrite rule for our Cloud Function.
The empty public/.gitignore file is to ensure public/ dir exists as it is required for Firebase Hosting. It is configured (by default) that dotfiles (public/.*) are ignored from bein publicly served.
The Cloud Function is named nextjsFunc (changeable in firebaseFunctions.js and firebase.json).
public/* files are statically served through Firebase hosting, not through NextJs server.

Customization

Next App is in src/ directory.

The crucial files for the setup:

.firebaserc
firebase.json
firebaseFunctions.js
src/next.config.js
In package.json: firebase-* packages.