Skip to content

Latest commit

 

History

History
106 lines (76 loc) · 3.24 KB

README.md

File metadata and controls

106 lines (76 loc) · 3.24 KB

js-data logo

js-data-firebase

Slack NPM Tests Downloads Coverage

Tested on IE9, Chrome 46, Firefox 41 & Safari 7.1 using bs logo

A Firebase adapter for the JSData Node.js ORM.

Installation

npm install --save js-data js-data-firebase firebase

Usage (Browser)

import { FirebaseAdapter } from 'js-data-firebase';

window.firebase.initializeApp({
  apiKey: window.API_KEY,
  authDomain: window.AUTH_DOMAIN,
  databaseURL: window.DATABASE_URL
});

// Create an instance of FirebaseAdapter
const adapter = new FirebaseAdapter({
  // baseRef: 'users', // optionally set a baseRef root
  db: window.firebase.database()
});

// Other JSData setup hidden

// Register the adapter instance
store.registerAdapter('firebase', adapter, { default: true });

Usage (Node.js)

import firebase from 'firebase';
import { FirebaseAdapter } from 'js-data-firebase';

firebase.initializeApp({
  databaseURL: process.env.DATABASE_URL,
  serviceAccount: process.env.KEY_FILENAME || 'key.json'
});

// Create an instance of FirebaseAdapter
const adapter = new FirebaseAdapter({
  db: firebase.database()
});

// Other JSData setup hidden

// Register the adapter instance
store.registerAdapter('firebase', adapter, { default: true });

JSData + Firebase Tutorial

Start with the JSData + Firebase tutorial or checkout the API Reference Documentation.

Need help?

Please post a question on Stack Overflow. This is the preferred method.

You can also chat with folks on the Slack Channel. If you end up getting your question answered, please still consider consider posting your question to Stack Overflow (then possibly answering it yourself). Thanks!

Want to contribute?

Awesome! You can get started over at the Contributing guide.

Thank you!

License

The MIT License (MIT)

Copyright (c) 2014-2017 js-data-firebase project authors