README.md

AngularFire2

The official library for Firebase and Angular 2

Status: Beta

What is AngularFire2?

• Observable based - Use the power of rxjs, Angular 2, and Firebase.
• Realtime bindings - Synchronize database collections as objects or lists.
• Authentication - Monitor authentication state in realtime.

Quick links

Contributing

Plunker Template - Requires to set your Firebase credentials in app.module.ts.

Upgrading to v4.0? Check out our guide.

Install

npm install firebase angularfire2 --save

Example use:

import {Component} from '@angular/core';
import {AngularFireDatabase, FirebaseListObservable} from 'angularfire2/database';

@Component({
  selector: 'project-name-app',
  template: `
  <ul>
    <li *ngFor="let item of items | async">
      {{ item.name }}
    </li>
  </ul>
  `
})
export class MyApp {
  items: FirebaseListObservable<any[]>;
  constructor(db: AngularFireDatabase) {
    this.items = db.list('/items');
  }
}

Developer Guide

If you want to get started quickly on building with AngularFire2, check out our 5 step developer guide that will teach you everything you need to know to be productive with AngularFire2.

1. Installation & Setup
2. Retreiving data as objects - FirebaseObjectObservable
3. Retreiving data as lists - FirebaseListObservable
4. Querying lists
5. User Authentication - FirebaseAuthentication
6. Using AngularFire2 with Ionic 2
7. Using AngularFire2 with Ionic 3 and Angular 4