How to

Setup

Project Configuration Branding Updating the Logo Updating the Fonts Updating the Favicons Environment variables Setting up Emails

Marketing Pages

Updating the Navigation menu Adding Pages

User Interface

Dark Theme Theming

Application Pages

Adding Pages Updating the Sidebar menu Passing data from server to client Guarding Pages

Authentication

Change Authentication strategy Require Email Verification

API Routes

Adding API Routes Guarding an API Route Calling API Routes from the client Checking CSRF Tokens

Contextual Data

Fetching the signed in User Fetching the selected Organization

Reading Data

Reading a Document Reading a list of Documents

Writing Data

Creating a Document Updating a Document Deleting a Document

Payments

Configuring Plans Running the Stripe Webhook locally Using Lemon Squeezy instead of Stripe

Translations

Adding a new translation string Setting a Default Language Adding a new language Using the Language Switcher Detect current Locale

Getting Started

Introduction Technical Details Clone the repository Running the application Coding Conventions

Configuration

Global Configuration Setting up your Firebase Project Feature Flags Setting up Firebase Functions

Architecture

Architecture and Folder Structure Structure your Application Data Model

UI

Tailwind CSS Shadcn UI Themes

Authentication

Auth Overview Setting up Firebase Auth Auth Flow Third-Party Providers Email Link Authentication Multi-Factor Authentication Requiring Email verification Auth SSR Page Guards API Guards Prevent abuse with AppCheck Custom React Hooks Troubleshooting

Data Fetching

Writing data to Firestore Fetching data from Firestore API requests Reading data from Storage Uploading data to Storage Writing your own Fetch

Development

Building Features Commands Code Style Security Rules Translations and Locales Sending Emails Writing API Routes Validating API payload with Zod Logging Enable CORS Encrypting Secrets User Roles

Payments

Stripe Configuration Stripe Webhooks One-Time Payments Migrate to Lemon Squeezy Disable Stripe

Admin

Overview Adding Admins

Blog and Docs

Overview Blog Documentation Search Functionality

Organizations

Overview Extending Organizations User Permissions Subscription Permissions Custom React Hooks

Utilities

MDX React Hooks

Migrations

Migrating to 0.11.0

Testing

Running Tests CI Tests Limitations

Going to Production

Production Checklist Environment Variables Security Rules

Plugins

Cookie Banner Feedback Popup AI Chatbot

API Reference

Reactfire useCurrentOrganization useCurrentUserRole useUserSession useIsSubscriptionActive withAppProps withTranslationProps withAuthProps withPipe withMethodsGuard withAuthedUser withExceptionFilter withCsrf

Documentation
Next.js Firebase
Environment Variables

Environment Variables

Learn how to use environment variables in your Next.js project.

The starter project comes with three different environment variables files:

.env: this is a shared environment file. Here, you can add variables shared across all the environments.
.env.development: the configuration file loaded when running the dev command: by default, we add the Firebase Emulators settings to this file.

Use this file for your development configuration.

.env.production: the configuration file loaded when running the build command locally or deployed to Vercel.

Use this file for your actual project's configuration (without private keys!).

.env.test: this environment file is loaded when running the Cypress E2E tests. You would rarely need to use this.

Additionally, you can add another environment file named .env.local: this file is never added to Git and can be used to store the secrets you need during development.

Never ever add secrets to your .env files. It's not safe, and you risk leaking confidential data.

Instead, add your secrets using your Vercel Console, or use the .env.local file during development.

Adding Environment Variables

The production environment variables template looks like the below:


NEXT_PUBLIC_FIREBASE_API_KEY=
NEXT_PUBLIC_FIREBASE_PROJECT_ID=
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=
NEXT_PUBLIC_FIREBASE_APP_ID=
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=
NEXT_PUBLIC_SITE_URL=
NEXT_PUBLIC_APPCHECK_KEY=
NEXT_PUBLIC_REQUIRE_EMAIL_VERIFICATION=false
 
SERVICE_ACCOUNT_CLIENT_EMAIL=
GCLOUD_PROJECT=
 
## SECRET KEYS ARE BEST ADDED TO YOUR CI
SERVICE_ACCOUNT_PRIVATE_KEY=
 
STRIPE_SECRET_KEY=
STRIPE_WEBHOOK_SECRET=

PreviousProject Configuration

Subscribe to our Newsletter

Get the latest updates about React, Remix, Next.js, Firebase, Supabase and Tailwind CSS

Adding Environment Variables

SECRET KEYS ARE BEST ADDED TO YOUR CI