forked from 0xTheProDev/Operational-Transformation
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(docs) Examples: Update collaborative-editors README file
The README file has been updated with purpose, prerequisites and running section. Fixes: 0xTheProDev#67 Signed-off-by: Lakshya Thakur lapstjup@gmail.com
- Loading branch information
1 parent
211c108
commit b2936d5
Showing
3 changed files
with
34 additions
and
0 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
## Purpose | ||
|
||
This example can help you get familiar with the API usage of `@otjs/firebase-ace` and `@otjs/firebase-monaco`. | ||
|
||
## Prerequisites | ||
|
||
If you followed the [installation](https://github.com/Progyan1997/Operational-Transformation#installation) steps successfully, you would have `lerna` and `yarn` installed globally. | ||
|
||
Before running this example, it's necessary to build all the packages using `yarn build` in the root (Operational-Transformation) directory. | ||
|
||
Also, the **_firebase.json_** in this directory has `database` entry where `rules` point to `".firebase/database.rules.json"` file which is not included with this repository. The user can add their own file with custom rules. | ||
|
||
For development purpose, the following can be the content of this file :- | ||
|
||
``` | ||
{ | ||
"rules":{ | ||
".read":true, | ||
".write":true | ||
} | ||
} | ||
``` | ||
|
||
## Running | ||
|
||
The example doesn't need the user to be authenticated with **firebase** since it runs local **firebase-emulator** for development purposes. | ||
|
||
- Run `yarn start` from the root of this directory to fire up both the emulator and the collaborative-editors UI (accessible at **localhost:8000**). | ||
 | ||
|
||
- Click on the editor you want to test and you will be redirected to it. | ||
- Copy the url and paste it in a new tab to open another session. | ||
- Start collaborating 🤝 | ||
 |