Real-time collaborative editor with out of the box binding with Firebase and Ace Editor.
npm install @otjs/firebase-ace@otjs/firebase-ace
> Real-time collaborative editor with out of the box binding with Firebase and Ace Editor.
- To install using Pnpm _(recommended)_:
``sh`
pnpm add @otjs/ace
- To install using Yarn:
`sh`
yarn add @otjs/firebase-ace
- To install using Npm:
`sh`
npm i @otjs/firebase-ace --save
Make sure to install all the peer dependencies beforehand:
`ts
import { FireAceEditor } from "@otjs/firebase-ace";
const fireAce = new FireAceEditor({
databaseRef: // Database Reference in Firebase Realtime DB
editor: // Ace Editor instance
announcementDuration: // Duration to hide Cursor tooltip (optional)
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.
We are using Jest to form our Unit Test Suite. Nyc _(formerly known as Istanbul)_ is used for coverage reporting.
To run all the unit test suites in local dev environment, run the following after dependencies have been installed:
`sh``
yarn test
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.
This project is licensed under the terms of the MIT license, see LICENSE for more details.