Installation

Fireclass setup starts with Firebase, not the CLI. Create the Firebase project, enable Firestore, and prepare the credentials or web configuration for your framework before running fireclass init.

Choose your framework

• Next.js App Router — server-only models, service-account environment variables, and the fireclass-ssr singleton.
• React — Firebase web configuration, src/lib/firebase.ts, and realtime hooks.
• Express / Node.js — Firebase Admin, src/lib/firebase.ts, and a lazy getDb() factory.

Each guide includes both the recommended CLI path and a complete manual path.

CLI path

Once the framework-specific Firebase setup is ready, run:

$ npx fireclass init

The CLI detects the framework and package manager, writes fireclass.json, installs the correct runtime, creates the Fireclass entry file and starter model, and enables TypeScript decorators. Existing Firebase files are only referenced.

npx fireclass doctor

Manual path

Use the framework pages above to install every dependency and create each file by hand. Manual installation follows the same boundaries as generated code:

• Firebase initialization lives in lib/firebase.ts for React and Express.
• Next.js uses fireclass-ssr directly and does not need a Firebase file.
• The local Fireclass entry exports only initialized values such as BaseModel, hooks, and adapter.
• Decorators and standalone helpers are imported directly from the runtime SDK.

What the CLI records

Every CLI setup writes a project-level fireclass.json. Read the configuration reference before changing its paths or exports manually.