🔥 Firebase: Staging & Production Projects

bg — Sun, 09 Feb 2020 02:31:34 +0000

▲🔥 Getting started with Next.js, ZEIT Now, and Firebase

bg ・ Feb 9 ・ 7 min read

In this sub-post, I'll walk through setting up a project in Firebase. The best way to create a production & staging environment for a new project in Firebase is to simply create two projects:

your-project-staging

your-project-production

1. Create a project

2. Add a web app

3. Enable email/password authentication

4. Set up Firestore

Run steps 1-4 twice, so that you end up with 2 projects:

▲🔥 Getting started with Next.js, ZEIT Now, and Firebase

bg ・ Feb 9 ・ 7 min read

#tutorial #zeit #firebase #react

🔥 Firebase: Onboarding 📸

bg ・ Feb 9 ・ 1 min read

#firebase #design #documentation

▲🔥 Getting started with Next.js, ZEIT Now, and Firebase

bg — Sun, 09 Feb 2020 02:24:52 +0000

This tutorial walks through setting up a minimal template project for Next.js, ZEIT Now, and Firebase.

I've included lots of screenshots, so even if you aren't interested in creating a project right now, you can get a feel for what working with these tools is like. I think this is a pretty good snapshot of the state of the art in 2020 for quick-start developer products.

The template project is an extension of the official Next.js with-firebase-authentication-serverless example, with a bit more functionality.

This tutorial provides some extra guidance on setting up staging & production environments in Firebase, and configuring ZEIT Now with your Firebase keys.

Recently, I started a new side project using:

Next.js (React framework for server-rendered applications)
▲ ZEIT Now (Hosting)
🔥 Firebase (Authentication, Storage, Functions)

I like this combination of tools ✨ so I decided to put together this detailed tutorial.

You can follow along using this template project:

benzguo / nextjs-now-firebase

Next.js + ZEIT Now + Firebase [template]

The template also includes Tailwind CSS (with ~zero styling). Here's what the sign up page looks like:

The app includes:

Sign up, log in, log out
Update display name
Add object to a Firestore collection
List objects in a Firestore collection (using firestore-pagination-hook)
Fetch data with a simple Firebase function (server-side rendering using getInitialProps)

▲ Sign up for ZEIT

[ > Sign up for ZEIT ]

I used the email signup flow, and thought it was pretty nice ✨ You can check out screenshots of the ZEIT onboarding flow [ ⤵️ here ].

We'll set up a ZEIT Now project at the end of the tutorial – all you have to do for now is sign up.

🔥 Set up Firebase projects

[ > Sign up for Firebase ]

Sign into your Firebase account, and create two projects (one for your staging environment, and another for your production environment).

You'll have to do a bit of clicking around to fully configure a new Firebase project. Check out the full walkthrough here:

🔥 Firebase: Staging & Production Projects

bg ・ Feb 9 ・ 1 min read

#tutorial #firebase #beginners

▲ Set up ZEIT Now CLI

Install the Now CLI and run now login

🔥 Set up Firebase CLI

Install the Firebase CLI and run firebase login

If you haven't done this already:

generate a new project from the GitHub template repo
clone it to your machine
and navigate to the directory in your terminal.

Add projects to Firebase CLI

Run firebase use --add to add the two projects you created to the Firebase CLI. Use "staging" and "production" as your project aliases.

Under the hood, this configuration is stored in your .firebaserc

▲🔥 Set up Now with Firebase keys

Staging environment

First, we'll configure our project's staging environment with keys from Firebase.

In the Firebase console, open your staging project, navigate to the "Service accounts" tab, and click "Generate new private key" to download your admin SDK keys.

Save the key file in the functions directory as serviceAccount-staging.json

📁 functions
├── serviceAccount-staging.json

⚠️ Your private key (in your service account key file) gives access to your project's Firebase services. Keep it confidential and never store it in a public repository.

Note that serviceAccount* files are in the project's .gitignore, so they won't be checked into your repository. Make sure you follow best practices for keeping these keys safe! 🔒

Next, find your app keys (under Project settings).

Enter these variables in the .env and .env.build files included in the template project.

Create two env files:
$ touch .env
$ touch .env.build

.env: runtime environment variables
.env.build: build step environment variables

Open your editor, and add the content below to the two new .env files (filling in your Firebase keys):

.env

# .env
# == Firebase app keys (staging) ==
FIREBASE_API_KEY=■■■■■■■■-■■■■■■■■
FIREBASE_AUTH_DOMAIN=■■■■■■■■.firebaseapp.com
FIREBASE_DATABASE_URL=https://■■■■■■■■.firebaseio.com
FIREBASE_PROJECT_ID=■■■■■■■■
FIREBASE_STORAGE_BUCKET=■■■■■■■■.appspot.com
FIREBASE_MESSAGING_SENDER_ID=■■■■■■■■
FIREBASE_APP_ID=1:■■■■■■■■:web:■■■■■■■■
FIREBASE_MEASUREMENT_ID=G-■■■■■■■■

.env.build

# .env.build
# == Firebase app keys (staging) ==
FIREBASE_API_KEY=■■■■■■■■-■■■■■■■■
FIREBASE_AUTH_DOMAIN=■■■■■■■■.firebaseapp.com
FIREBASE_DATABASE_URL=https://■■■■■■■■.firebaseio.com
FIREBASE_PROJECT_ID=■■■■■■■■
FIREBASE_STORAGE_BUCKET=■■■■■■■■.appspot.com
FIREBASE_MESSAGING_SENDER_ID=■■■■■■■■
FIREBASE_APP_ID=1:■■■■■■■■:web:■■■■■■■■
FIREBASE_MEASUREMENT_ID=G-■■■■■■■■
# == Firebase admin keys (from serviceAccount-staging.json) ==
FIREBASE_CLIENT_EMAIL=firebase-adminsdk-■■■■@■■■■■■■■.iam.gserviceaccount.com
FIREBASE_PRIVATE_KEY=-----BEGIN PRIVATE KEY-----\n■■■■■■■■\n-----END PRIVATE KEY-----\n

⚠️ These keys give access to your project's Firebase services. Keep them confidential and never store them in a public repository.

Note that .env* files are in the project's .gitignore, so they won't be checked into your repository. Make sure you follow best practices for keeping these keys safe! 🔒

Now, you're ready to try running the app locally.

$ npm install
$ npm run dev

When you open http://localhost:3000 in your browser, you should see this page:

Try creating an account! ✅

Production environment

Now, we'll configure the project's production environment with keys from Firebase.

Open your production project in the Firebase console, and follow the same steps as above:

Download your admin keys to /functions/serviceAccount-production.json
Find your app keys in the Firebase console's Project settings page.

Run the following commands to add your production Firebase keys to Now:

$ now secrets add firebase-api-key ■■■■■■■■-■■■■■■■■

$ now secrets add firebase-auth-domain ■■■■■■■■.firebaseapp.com

$ now secrets add firebase-database-url https://■■■■■■■■.firebaseio.com

$ now secrets add firebase-project-id ■■■■■■■■

$ now secrets add firebase-storage-bucket ■■■■■■■■.appspot.com

$ now secrets add firebase-messaging-sender-id ■■■■■■■■

$ now secrets add firebase-app-id 1:■■■■■■■■:web:■■■■■■■■

$ now secrets add firebase-measurement-id G-■■■■■■■■

$ now secrets add firebase-client-email firebase-adminsdk-■■■■@■■■■■■■■.iam.gserviceaccount.com

$ now secrets add -- firebase-private-key "-----BEGIN PRIVATE KEY-----\n■■■■■■■■\n-----END PRIVATE KEY-----\n"

🔥 Create a Firestore index

Here, we'll walk through creating an index in Firestore. You'll go through this flow pretty often as you iterate on your app's data model.

Navigate to http://localhost:3000/spaces, and open your browser's console.

You should see an error in the console, with a link to create an index.

Following the link takes you to the Firestore dashboard, with a modal to create a new index:

This workflow is great for prototyping. As you solidify your data model, you can switch to deploying indexes from the CLI.

🔥 Set up Firebase functions

Here, we'll configure Firebase functions to support deploying to staging & production, and then deploy functions.

Now, navigate to http://localhost:3000/account

You should see an error! 🛑

This page makes a request to a Firebase function, and we haven't deployed functions yet.

To set up functions, we'll configure our staging & production projects with an environment config variable. Functions use this config variable to decide which keys to use at runtime.

$ firebase use staging
Now using alias staging (my-project-staging)

$ firebase functions:config:set app.environment="staging"
✔  Functions config updated.

$ firebase use production
Now using alias production (my-project-production)

$ firebase functions:config:set app.environment="production"
✔  Functions config updated.

Now, we can deploy functions to staging and production.

First, install dependencies:
$ cd functions && npm install && cd ..

Deploy to staging:
$ firebase deploy -P staging --only functions

Deploy to production:
$ firebase deploy -P production --only functions

Open the account page again: http://localhost:3000/account.

You should now be able to load the page without errors! ✅

▲ Deploy to ZEIT Now

You've reached the final step! 🏁🥳

Run now to set up a ZEIT Now project and deploy to production.

$ now

My ZEIT Now dashboard, after deploying the project

In the future, you can deploy your app to production by running now --prod

To run the app locally, run now dev

📌 Reference

Run app locally (using staging environment)

$ now dev

Deploy functions to staging

$ firebase deploy -P staging --only functions

Deploy functions to production

$ firebase deploy -P production --only functions

Run functions locally

$ cd functions && npm run shell

Deploy to production

$ now --prod

Running functions locally

To run Firebase functions locally, navigate to the functions directory and run npm run shell

$ cd functions && npm run shell
...
✔  functions: Emulator started at http://localhost:5000
i  functions: Loaded functions: getEnvironment
firebase > getEnvironment({})
Sent request to function.
firebase > 
RESPONSE RECEIVED FROM FUNCTION: 200, {
  "result": {
    "environment": "staging"
  }
}

This project is configured to use the staging environment when running functions locally.

Running functions locally can be convenient for development, but handling authenticated functions can be tricky. Firebase has some local emulators, but it's unclear what the story is for emulating authentication.

Often, I'll just deploy functions directly to staging, and open http://localhost:3000 to verify changes.

DEV Community: bg

🔥 Firebase: Onboarding 📸

▲🔥 Getting started with Next.js, ZEIT Now, and Firebase

bg ・ Feb 9 ・ 7 min read

🔥 Firebase: Staging & Production Projects

bg ・ Feb 9 ・ 1 min read

▲ ZEIT Now: Onboarding 📸

bg ・ Feb 9 ・ 1 min read

🔥 Firebase: Staging & Production Projects

▲🔥 Getting started with Next.js, ZEIT Now, and Firebase

bg ・ Feb 9 ・ 7 min read

1. Create a project

2. Add a web app

3. Enable email/password authentication

4. Set up Firestore

▲🔥 Getting started with Next.js, ZEIT Now, and Firebase

bg ・ Feb 9 ・ 7 min read

🔥 Firebase: Onboarding 📸

bg ・ Feb 9 ・ 1 min read

▲🔥 Getting started with Next.js, ZEIT Now, and Firebase

benzguo / nextjs-now-firebase

Next.js + ZEIT Now + Firebase [template]

▲ Sign up for ZEIT

🔥 Set up Firebase projects

🔥 Firebase: Staging & Production Projects

bg ・ Feb 9 ・ 1 min read

▲ Set up ZEIT Now CLI

🔥 Set up Firebase CLI

benzguo / nextjs-now-firebase

Next.js + ZEIT Now + Firebase [template]

Add projects to Firebase CLI

▲🔥 Set up Now with Firebase keys

Staging environment

.env

.env.build

Production environment

🔥 Create a Firestore index

🔥 Set up Firebase functions

▲ Deploy to ZEIT Now

📌 Reference

Run app locally (using staging environment)

Deploy functions to staging

Deploy functions to production

Run functions locally

Deploy to production

Running functions locally

🔗 Related posts

Type-safe Payments with Next.js, TypeScript, and Stripe 🔒💸

Thor 雷神 ・ Feb 11 ・ 11 min read

NextJS vs GatsbyJS - What's the diff?

Michael Friedman ・ Aug 16 '19 ・ 5 min read

▲ ZEIT Now: Onboarding 📸

▲🔥 Getting started with Next.js, ZEIT Now, and Firebase

bg ・ Feb 9 ・ 7 min read

▲🔥 Getting started with Next.js, ZEIT Now, and Firebase

bg ・ Feb 9 ・ 7 min read

🔥 Firebase: Onboarding 📸

bg ・ Feb 9 ・ 1 min read

Thor 雷神・ Feb 11 ・ 11 min read