@1amageek/reaf
v1.0.1
Published
Host Next.js SSR app on Firebase Cloud Functions with Firebase Hosting redirects. Built with typescript.
Downloads
15
Readme
With Firebase Hosting and Typescript 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-and-typescript with-firebase-hosting-and-typescript-app
# or
yarn create next-app --example with-firebase-hosting-and-typescript with-firebase-hosting-and-typescript-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-and-typescript
cd with-firebase-hosting-and-typescript
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 - 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, with a complete Typescript stack for both the Next app and for the Firebase Functions. 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 of @jthegedus in the with-firebase-hosting example.
If you're having issues, feel free to tag @sampsonjoliver 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 emptypublic/
folder and still hosts at the Firebase project URL. firebase.json
outlines the catchall rewrite rule for our Cloud Function.- The Firebase predeploy hooks defined in
firebase.json
will handle linting and compiling of the next app and the functions sourceswhenfirebase deploy
is invoked. The only scripts you should need aredev
,clean
anddeploy
. - Specifying
"engines": {"node": "8"}
in thepackage.json
is required for firebase functions to be deployed on Node 8 rather than Node 6 (Firebase Blog Announcement) . This is matched in by specifying target ases2017
insrc/functions/tsconfig.json
so that typescript output somewhat compacter and moderner code.