Prerequisites

Complete these steps before running fireclass init. Fireclass can scaffold application files, but it cannot create your Firebase project, enable Firestore, or choose credentials for you.

Development environment

• Node.js 18 or newer.
• A TypeScript Next.js, React, or Express project.
• npm, pnpm, Yarn, or Bun.
• A Firebase project with a Firestore database.

Fireclass models use TypeScript decorators. The CLI enables them automatically; manual installations add the compiler options in the framework guide.

Create the Firebase project

1. Open the Firebase Console.
2. Create or select a project.
3. Open Build → Firestore Database and create the database.
4. Choose security rules appropriate for the application.

Prepare framework credentials

React

Register a Firebase Web app and copy its public web configuration. React uses VITE_FIREBASE_* values and a client-side src/lib/firebase.ts. Never put a service-account private key in a Vite variable.

Continue with React setup.

Next.js

Create a service account under Project settings → Service accounts, or use Application Default Credentials on a supported Google runtime. Local development normally uses FIREBASE_PROJECT_ID, FIREBASE_CLIENT_EMAIL, and FIREBASE_PRIVATE_KEY in .env.local.

Continue with Next.js setup.

Express / Node.js

Create a service account or configure Application Default Credentials. The recommended local setup uses PROJECT_ID, CLIENT_EMAIL, and PRIVATE_KEY in a gitignored .env, with a lazy src/lib/firebase.ts factory.

Continue with Express setup.

Before init checklist

• Firestore is enabled in the correct Firebase project.
• React has a registered web app; server frameworks have a service account or ADC.
• Environment files are gitignored.
• React and Express have the recommended Firebase file and export ready.
• Next.js credentials are available in .env.local or through ADC.

After the checklist passes, return to Installation and run fireclass init.