Quick Start Guide

Get up and running with Firebase ORM in minutes. This guide will walk you through creating your first model and performing basic operations.

Prerequisites

Before you begin, make sure you have:

Node.js 14 or higher installed
A Firebase project with Firestore enabled
Basic knowledge of TypeScript/JavaScript

Installation

Install Firebase ORM and its dependencies:

npm install @arbel/firebase-orm firebase moment --save

For server-side applications:

npm install @arbel/firebase-orm firebase-admin moment --save

Basic Configuration

1. Initialize Firebase

Create a Firebase configuration file:

// config/firebase.ts
import { initializeApp } from 'firebase/app';
import { getFirestore } from 'firebase/firestore';
import { FirestoreOrmRepository } from '@arbel/firebase-orm';

const firebaseConfig = {
  apiKey: "your-api-key",
  authDomain: "your-project.firebaseapp.com",
  projectId: "your-project-id",
  storageBucket: "your-project.appspot.com",
  messagingSenderId: "123456789",
  appId: "your-app-id"
};

// Initialize Firebase
const app = initializeApp(firebaseConfig);
const firestore = getFirestore(app);

// Initialize Firebase ORM
FirestoreOrmRepository.initGlobalConnection(firestore);

2. TypeScript Configuration

Ensure your tsconfig.json includes:

{
  "compilerOptions": {
    "experimentalDecorators": true,
    "emitDecoratorMetadata": true,
    "strictPropertyInitialization": false
  }
}

Your First Model

Let's create a simple User model:

// models/User.ts
import { BaseModel, Model, Field } from '@arbel/firebase-orm';

@Model({
  reference_path: 'users',
  path_id: 'user_id'
})
export class User extends BaseModel {
  @Field({ is_required: true })
  public name!: string;

  @Field({ is_required: true })
  public email!: string;

  @Field({ field_name: 'created_at' })
  public createdAt?: string;

  @Field({ is_required: false })
  public bio?: string;

  // Helper method
  getDisplayName(): string {
    return this.name || this.email;
  }
}

Basic Operations

Creating Records

// Create a new user
const user = new User();
user.name = 'John Doe';
user.email = 'john@example.com';
user.bio = 'Software developer';
user.createdAt = new Date().toISOString();

// Save to Firestore
await user.save();

console.log('User created with ID:', user.getId());

Reading Records

// Get all users
const allUsers = await User.getAll();
console.log('All users:', allUsers);

// Get a specific user by ID - SIMPLIFIED PATTERN ⚡
const specificUser = await User.init('user-id-here');
if (specificUser) {
  console.log('User:', specificUser.name);
} else {
  console.log('User not found');
}

// Alternative traditional pattern (still supported)
const traditionalUser = new User();
await traditionalUser.load('user-id-here');
console.log('User:', traditionalUser.name);

// Find users with conditions
const johnUsers = await User.query()
  .where('name', '==', 'John Doe')
  .get();

console.log('Users named John:', johnUsers);

Updating Records

// Load an existing user - SIMPLIFIED PATTERN ⚡
const user = await User.init('user-id-here');

if (user) {
  // Update properties
  user.name = 'John Smith';
  user.bio = 'Senior Software Developer';

  // Save changes
  await user.save();

  console.log('User updated!');
}

Deleting Records

// Load and delete a user - SIMPLIFIED PATTERN ⚡
const user = await User.init('user-id-here');

if (user) {
  await user.destroy();
  console.log('User deleted!');
}

Advanced Querying

Firebase ORM provides a powerful query interface:

// Complex queries
const activeUsers = await User.query()
  .where('isActive', '==', true)
  .where('createdAt', '>', '2024-01-01')
  .orderBy('createdAt', 'desc')
  .limit(10)
  .get();

// Pagination
const firstPage = await User.query()
  .orderBy('name')
  .limit(5)
  .get();

// Get next page using the last document
const lastDoc = firstPage[firstPage.length - 1];
const nextPage = await User.query()
  .orderBy('name')
  .startAfter(lastDoc.name)
  .limit(5)
  .get();

Real-time Updates

Listen to real-time changes in your data:

// Listen to all user changes
const unsubscribe = User.onList((user) => {
  console.log('User updated:', user.name);
});

// Listen to a specific user
const user = new User();
await user.load('user-id-here');

const unsubscribeUser = user.on(() => {
  console.log('User data changed:', user.name);
});

// Don't forget to unsubscribe when done
// unsubscribe();
// unsubscribeUser();

Working with Nested Collections

Firebase ORM supports hierarchical data structures with nested collections:

// Define a nested model
@Model({
  reference_path: 'websites/:website_id/members',
  path_id: 'member_id'
})
export class Member extends BaseModel {
  @Field({ is_required: true })
  public name!: string;

  @Field({ field_name: 'photo_url' })
  public photoUrl!: string;
}

// Load a member using the simplified init pattern ⚡
const member = await Member.init(memberId, { website_id: websiteId });
if (member) {
  console.log(member.name);
}

// Traditional pattern (still supported)
const member2 = new Member();
member2.setPathParams('website_id', websiteId);
await member2.load(memberId);

// Create a new member in a nested collection
const newMember = new Member();
newMember.setPathParams('website_id', websiteId);
newMember.name = 'John Doe';
newMember.photoUrl = 'https://example.com/photo.jpg';
await newMember.save();

🚀 NEW: Simplified Path Parameters with `initPath()` / `initPathParams()`

For an even cleaner API, use the static initPath() or initPathParams() method to set all path parameters at once:

// ✨ NEW: Set all path params at once and chain directly!
// Use the shorter initPath() or the more explicit initPathParams()
const allMembers = await Member.initPath({
  website_id: websiteId
}).getAll();

// Works with queries too
const activeMembers = await Member.initPath({
  website_id: websiteId
}).query()
  .where('status', '==', 'active')
  .orderBy('name')
  .get();

// Complex nested structures
@Model({
  reference_path: 'courses/:course_id/lessons/:lesson_id/questions',
  path_id: 'question_id'
})
export class Question extends BaseModel {
  @Field() public text!: string;
  @Field() public difficulty!: number;
}

// Before: Multiple lines to set params
const questionModel = new Question();
questionModel.setPathParams('course_id', courseId);
questionModel.setPathParams('lesson_id', lessonId);
const allQuestions = await questionModel.getAll();

// After: Single line! ⚡
const allQuestions = await Question.initPath({
  course_id: courseId,
  lesson_id: lessonId
}).getAll();

// You can still modify the instance after initialization
const question = Question.initPath({
  course_id: courseId,
  lesson_id: lessonId
});
question.text = 'What is TypeScript?';
question.difficulty = 2;
await question.save();

Key Points:

Use :parameter_name syntax in reference_path to define path parameters
NEW: Use initPath({...}) or initPathParams({...}) for cleaner, chainable API when setting multiple params
Both methods are equivalent - initPath() is shorter, initPathParams() is more explicit
Pass path parameters as the second argument to init() when loading by ID
Use setPathParams() for individual parameter setting or when creating instances with the constructor

Working with Relationships

Define relationships between models:

// Post model with relationship to User
import { HasMany, BelongsTo } from '@arbel/firebase-orm';

@Model({
  reference_path: 'posts',
  path_id: 'post_id'
})
export class Post extends BaseModel {
  @Field({ is_required: true })
  public title!: string;

  @Field({ is_required: true })
  public content!: string;

  @Field({ field_name: 'author_id' })
  public authorId!: string;

  @BelongsTo({ model: User, localKey: 'authorId' })
  public author?: User;
}

// Update User model to include posts
@Model({
  reference_path: 'users',
  path_id: 'user_id'
})
export class User extends BaseModel {
  // ... existing fields ...

  @HasMany({ model: Post, foreignKey: 'author_id' })
  public posts?: Post[];
}

Using Relationships

// Load a user with their posts
const user = new User();
await user.load('user-id-here');

// Load related posts
const posts = await user.loadHasMany('posts');
console.log(`${user.name} has ${posts.length} posts`);

// Load a post with its author
const post = new Post();
await post.load('post-id-here');

const author = await post.loadBelongsTo('author');
console.log(`Post "${post.title}" by ${author.name}`);

Error Handling

Always wrap database operations in try-catch blocks:

try {
  const user = new User();
  await user.load('non-existent-id');
} catch (error) {
  if (error.message.includes('not found')) {
    console.log('User not found');
  } else {
    console.error('Database error:', error);
  }
}

Complete Example

Here's a complete example that puts it all together:

import { initializeApp } from 'firebase/app';
import { getFirestore } from 'firebase/firestore';
import { FirestoreOrmRepository, BaseModel, Model, Field, HasMany } from '@arbel/firebase-orm';

// Initialize Firebase
const app = initializeApp({
  // your Firebase config
});
const firestore = getFirestore(app);
FirestoreOrmRepository.initGlobalConnection(firestore);

// Define models
@Model({
  reference_path: 'users',
  path_id: 'user_id'
})
class User extends BaseModel {
  @Field({ is_required: true })
  public name!: string;

  @Field({ is_required: true })
  public email!: string;

  @Field({ field_name: 'created_at' })
  public createdAt?: string;

  @HasMany({ model: Post, foreignKey: 'author_id' })
  public posts?: Post[];
}

@Model({
  reference_path: 'posts',
  path_id: 'post_id'
})
class Post extends BaseModel {
  @Field({ is_required: true })
  public title!: string;

  @Field({ is_required: true })
  public content!: string;

  @Field({ field_name: 'author_id' })
  public authorId!: string;
}

// Main application logic
async function main() {
  try {
    // Create a user
    const user = new User();
    user.name = 'Alice Johnson';
    user.email = 'alice@example.com';
    user.createdAt = new Date().toISOString();
    await user.save();

    console.log('✅ User created:', user.getId());

    // Create a post by this user
    const post = new Post();
    post.title = 'My First Post';
    post.content = 'This is the content of my first post!';
    post.authorId = user.getId();
    await post.save();

    console.log('✅ Post created:', post.getId());

    // Load user with their posts
    const userWithPosts = new User();
    await userWithPosts.load(user.getId());
    const posts = await userWithPosts.loadHasMany('posts');

    console.log(`✅ ${userWithPosts.name} has ${posts.length} post(s)`);

    // Query all users
    const allUsers = await User.getAll();
    console.log(`✅ Total users: ${allUsers.length}`);

  } catch (error) {
    console.error('❌ Error:', error);
  }
}

// Run the example
main();

Next Steps

Now that you've learned the basics, explore more advanced features:

Models & Fields - Learn about advanced field types and model configuration
Relationships - Master one-to-one, one-to-many, and many-to-many relationships
Querying Data - Discover advanced querying techniques
Real-time Features - Build reactive applications with live data updates

Framework Integration

Check out our framework-specific guides:

Angular - Services, components, and dependency injection
React - Hooks, context, and state management
Vue.js - Composables and reactive data
Next.js - SSR, SSG, and API routes
Node.js - Express APIs and backend services

Common Patterns

Data Validation

@Model({
  reference_path: 'users',
  path_id: 'user_id'
})
export class User extends BaseModel {
  @Field({ is_required: true })
  public email!: string;

  // Override save to add validation
  async save() {
    // Validate email format
    const emailRegex = /^[^\s@]+@[^\s@]+\.[^\s@]+$/;
    if (!emailRegex.test(this.email)) {
      throw new Error('Invalid email format');
    }

    // Call parent save method
    return super.save();
  }
}

Soft Deletes

@Model({
  reference_path: 'users',
  path_id: 'user_id'
})
export class User extends BaseModel {
  @Field({ is_required: false, default_value: true })
  public isActive?: boolean;

  @Field({ field_name: 'deleted_at' })
  public deletedAt?: string;

  // Soft delete method
  async softDelete() {
    this.isActive = false;
    this.deletedAt = new Date().toISOString();
    await this.save();
  }

  // Override getAll to exclude soft deleted records
  static async getAll() {
    return await User.query()
      .where('isActive', '==', true)
      .get();
  }
}

Timestamps

@Model({
  reference_path: 'posts',
  path_id: 'post_id'
})
export class Post extends BaseModel {
  @Field({ field_name: 'created_at' })
  public createdAt?: string;

  @Field({ field_name: 'updated_at' })
  public updatedAt?: string;

  // Override save to add timestamps
  async save() {
    const now = new Date().toISOString();
    
    if (!this.getId()) {
      // New record
      this.createdAt = now;
    }
    
    this.updatedAt = now;
    
    return super.save();
  }
}

Troubleshooting

Common Issues

Issue: "Cannot find decorator metadata" Solution: Ensure experimentalDecorators and emitDecoratorMetadata are enabled in tsconfig.json

Issue: "FirestoreOrmRepository is not initialized" Solution: Make sure you call FirestoreOrmRepository.initGlobalConnection() before using any models

Issue: "Permission denied" errors Solution: Check your Firestore security rules and ensure proper authentication

Issue: Real-time listeners not working Solution: Verify that you're using the client-side Firebase SDK, not the Admin SDK

Getting Help

Check the Troubleshooting Guide for detailed solutions
Review the Common Patterns for best practices
Look at the Complete Examples for working code samples

What's Next?

You're now ready to build powerful applications with Firebase ORM! Continue with:

Basic Concepts for deeper understanding
Models & Fields for advanced model features
Framework-specific guides for your preferred technology stack

Happy coding! 🚀

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Quick Start Guide

Prerequisites

Installation

Basic Configuration

1. Initialize Firebase

2. TypeScript Configuration

Your First Model

Basic Operations

Creating Records

Reading Records

Updating Records

Deleting Records

Advanced Querying

Real-time Updates

Working with Nested Collections

🚀 NEW: Simplified Path Parameters with `initPath()` / `initPathParams()`

Working with Relationships

Using Relationships

Error Handling

Complete Example

Next Steps

Framework Integration

Common Patterns

Data Validation

Soft Deletes

Timestamps

Troubleshooting

Common Issues

Getting Help

What's Next?

FilesExpand file tree

quick-start.md

Latest commit

History

quick-start.md

File metadata and controls

Quick Start Guide

Prerequisites

Installation

Basic Configuration

1. Initialize Firebase

2. TypeScript Configuration

Your First Model

Basic Operations

Creating Records

Reading Records

Updating Records

Deleting Records

Advanced Querying

Real-time Updates

Working with Nested Collections

🚀 NEW: Simplified Path Parameters with initPath() / initPathParams()

Working with Relationships

Using Relationships

Error Handling

Complete Example

Next Steps

Framework Integration

Common Patterns

Data Validation

Soft Deletes

Timestamps

Troubleshooting

Common Issues

Getting Help

What's Next?

🚀 NEW: Simplified Path Parameters with `initPath()` / `initPathParams()`