Initial commit

Author: onexdata

README.md

@@ -1,2 +1,30 @@
 # realtime-editor.js
-A realtime editor.js collaborative interface based on OT (instead of CRDTs)
+A realtime editor.js collaborative interface based on OT (instead of CRDTs). The goal for this repo is simplicity, so people can understand how easy collaborative realtime editing can be using OT (Operational Transforms).
+
+I didn't do much more than setup the basics using editor.js.
+
+If you add editor.js blocks besides headings and text, it will just show that users cursor on that block.
+
+I tested this with 10 clients and there were no issues. Collaborating with more than 10 people would probably melt your users brains before the server would go above 1% usage, so this scales just fine for any sort of document collaboration.
+
+Operational Transforms (OT) are simpler and much faster than CRDTs, and take advantage of structures like JSON.
+
+I implemented this with ShareDB which handles all complexities of OT.
+
+Google Docs and most apps that don't need more than a few dozen collaborators seem to all select OT over CRDT.
+
+# Install
+
+```
+npm i
+```
+
+# Build
+```
+npm run build
+```
+
+# Start
+```
+npm start
+```

package-lock.json

@@ -0,0 +1,27 @@
+{
+    "name": "collaborative-editorjs",
+    "version": "1.0.0",
+    "description": "Collaborative Editor.js implementation using ShareDB",
+    "main": "server.js",
+    "scripts": {
+      "start": "node server.js",
+      "dev": "nodemon server.js",
+      "build": "webpack --mode production"
+    },
+    "dependencies": {
+      "@editorjs/editorjs": "^2.28.2",
+      "@editorjs/header": "^2.8.1",
+      "@editorjs/list": "^1.9.0",
+      "@editorjs/paragraph": "^2.11.3",
+      "express": "^4.18.2",
+      "reconnecting-websocket": "^4.4.0",
+      "sharedb": "^3.3.0",
+      "websocket-json-stream": "^0.0.3",
+      "ws": "^8.14.2"
+    },
+    "devDependencies": {
+      "nodemon": "^3.0.1",
+      "webpack": "^5.89.0",
+      "webpack-cli": "^5.1.4"
+    }
+  }