Getting Started

Installation

Configure registry access and install @frappes/firebase.

Install @frappes/firebase in two steps:

1) Configure your registry first

Add this in your project .npmrc:

.npmrc

@frappes:registry=https://npm.pkg.github.com

If your registry requires authentication, also add:

.npmrc

//npm.pkg.github.com/:_authToken=${GITHUB_TOKEN}

Do not commit plaintext tokens. Use environment variables (for example GITHUB_TOKEN) in CI/local shells.

pnpm add @frappes/firebase firebase

npm install @frappes/firebase firebase

yarn add @frappes/firebase firebase

bun add @frappes/firebase firebase

firebase is required when using createFirebaseFirestorePort.

check.ts

import { createFirestoreCoreClient } from "@frappes/firebase"

console.log(typeof createFirestoreCoreClient)

If this compiles, your install is ready.

Introduction

What @frappes/firebase provides and when to use it.

Quick Start

Create a client and perform your first writes.