@otjs/firebase-plaintext

Description

Database Adapter implementation for Firebase.

Installation

• To install using Pnpm (recommended):

  pnpm add @otjs/ace

• To install using Yarn:

  yarn add @otjs/firebase-plaintext

• To install using Npm:

  npm i @otjs/firebase-plaintext --save

Peer Dependencies

Make sure to install all the peer dependencies beforehand:

Usage

import { FirebaseAdapter } from "@otjs/firebase-plaintext";

const firebaseAdapter = new FirebaseAdapter({
  databaseRef:  // Database Reference in Firebase Realtime DB
  userId:       // Unique Identifier for current user
  userColor:    // Unique Color Code for current user
  userName:     // Human readable Name or Short Name (optional)
});

Note: An API documentation will be shipped along with the package. This will power intellisense in the editor of your choice.

Testing

We don't have any Unit Test Suite for @otjs/firebase-plaintext. Please refer to root README for details regarding Integration Test Suite that concerns firebase.

Reporting a Bug

Head on to Discussion section to report a bug or to ask for any feature. Use this template to make it structural and helpful for the maintainer and the contributors. Feel to add your queries about using this library as well under Q & A section of it. Remember, do not create any Issues by yourself, maintainers of this repository will open one if deemed necessary.

Changelog

See CHANGELOG for more details on what has been changed in the latest release.

Contributing

See Contributing Guidelines.

License

This project is licensed under the terms of the MIT license, see LICENSE for more details.