Firebase Database Plugin for API Buddy

This plugin provides Firebase Database integration for API Buddy, allowing you to easily generate type-safe API routes from Zod schemas.

Features

• 🔥 Generate CRUD API routes for Firestore
• 🛡️ Type-safe database operations with Zod
• ⚡ Real-time data synchronization
• 🚀 Easy setup and configuration

Installation

# Using pnpm
pnpm add -D @api-buddy/plugin-database-firebase firebase firebase-admin

# Using npm
npm install --save-dev @api-buddy/plugin-database-firebase firebase firebase-admin

# Using yarn
yarn add -D @api-buddy/plugin-database-firebase firebase firebase-admin

Getting Started

1. Initialize Firebase Database

   api-buddy firebase-db init --project-id=your-project-id

2. Create a Schema Create a new schema file in the schemas directory:

   // schemas/product.ts
   import { z } from 'zod';
      
   export const ProductSchema = z.object({
     name: z.string().min(3),
     price: z.number().positive(),
     category: z.enum(['electronics', 'clothing', 'home']),
     description: z.string().optional(),
     createdAt: z.date().default(() => new Date()),
     updatedAt: z.date().default(() => new Date())
   });
      
   export type Product = z.infer<typeof ProductSchema>;

3. Generate API Routes

   api-buddy firebase-db generate:api product --schema=schemas/product.ts

4. Use the API

   // Example: Create a new product
   const response = await fetch('/api/product', {
     method: 'POST',
     headers: { 'Content-Type': 'application/json' },
     body: JSON.stringify({
       name: 'Example Product',
       price: 99.99,
       category: 'electronics'
     })
   });
      
   // Example: Fetch all products
   const products = await fetch('/api/product').then(res => res.json());

Available Commands

api-buddy firebase-db init

Initialize Firebase Database in your project.

Options:

• --project-id <id>: Firebase project ID
• --emulator: Set up Firebase emulator

api-buddy firebase-db generate:api <model>

Generate API routes from a schema.

Options:

• --schema <path>: Path to schema file (default: schemas/<model>.ts)

Configuration

Environment Variables

# Firebase Admin SDK
FIREBASE_SERVICE_ACCOUNT={"type":"service_account",...}

# Firebase Client (optional)
NEXT_PUBLIC_FIREBASE_API_KEY=your-api-key
NEXT_PUBLIC_FIREBASE_AUTH_DOMAIN=your-project.firebaseapp.com
NEXT_PUBLIC_FIREBASE_PROJECT_ID=your-project-id
NEXT_PUBLIC_FIREBASE_STORAGE_BUCKET=your-project.appspot.com
NEXT_PUBLIC_FIREBASE_MESSAGING_SENDER_ID=your-sender-id
NEXT_PUBLIC_FIREBASE_APP_ID=your-app-id
NEXT_PUBLIC_FIREBASE_MEASUREMENT_ID=your-measurement-id

License

MIT

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

Future Features

See V2.md for planned features and improvements.