@simondotm/nx-firebase

A plugin for Nx v16.1.1+ that provides support for Firebase projects in an Nx monorepo workspace.

See CHANGELOG for release notes.

This plugin was completely rewritten since V2.x. For documentation of the legacy v1.x plugin version see here.

Overview

Nx provides a great way to manage monorepo workflows and this plugin helps make it easy to integrate Firebase projects with Nx.

Features:

• Supports single or multiple firebase projects/apps within an Nx workspace
• Generates Firebase node applications, with default firebase.json configurations, rules and indexes for each Firebase app
• Generates Firebase functions using customised Typescript Nx node applications
• Bundling of functions using esbuild for extremely fast compilation & tree-shaking for faster cold starts
• Easily import Typescript code libraries in your Firebase functions for code sharing
• Nx's automatic dependency checking for no-fuss builds, and per-project or per-function deployments
• Use the Firebase Emulator suite whilst developing locally - all functions are watched and updated live while you work
• Workspace management with the sync generator keeps your firebase.json configs automatically updated when renaming or deleting functions
• Only very lightly opinionated about your Firebase configurations and workspace layouts; you can use Nx or the Firebase CLI

User Guide

• Quick Start
• Migrating from plugin v1.x to v2.x

Nx Firebase Generators

• Firebase Applications
• Firebase Functions
• Firebase Sync

Nx Firebase

• Firebase Hosting
• Firebase Emulators
• Firebase Databases
• Firebase Projects
• Firebase Versions

Nx Workspace

• Using Nx Libraries with Firebase Functions
• Migrating an existing Firebase project to Nx
• Nx Versions

Notes

• Plugin Development Notes
• Nx Development Setup for Mac