From ba447b78e10d667e346beaca2284afbe3096011d Mon Sep 17 00:00:00 2001
From: Marvin Wu <marvinwu@gmail.com>
Date: Thu, 14 Apr 2022 15:48:39 +0800
Subject: [PATCH 1/2] tip tab realtime edit example

---
 examples/tiptap-collab-editing/.eslintrc.js   |   3 ++
 examples/tiptap-collab-editing/.gitignore     |   6 +++
 examples/tiptap-collab-editing/README.md      |  23 ++++++++++++
 .../app/entry.client.tsx                      |   4 ++
 .../app/entry.server.tsx                      |  21 +++++++++++
 examples/tiptap-collab-editing/app/root.tsx   |  32 ++++++++++++++++
 .../app/routes/editor.tsx                     |  32 ++++++++++++++++
 .../app/utils/webrtc.client.tsx               |   6 +++
 examples/tiptap-collab-editing/package.json   |  35 ++++++++++++++++++
 .../tiptap-collab-editing/public/favicon.ico  | Bin 0 -> 16958 bytes
 .../tiptap-collab-editing/remix.config.js     |  10 +++++
 examples/tiptap-collab-editing/remix.env.d.ts |   2 +
 .../tiptap-collab-editing/sandbox.config.json |   6 +++
 examples/tiptap-collab-editing/tsconfig.json  |  20 ++++++++++
 14 files changed, 200 insertions(+)
 create mode 100644 examples/tiptap-collab-editing/.eslintrc.js
 create mode 100644 examples/tiptap-collab-editing/.gitignore
 create mode 100644 examples/tiptap-collab-editing/README.md
 create mode 100644 examples/tiptap-collab-editing/app/entry.client.tsx
 create mode 100644 examples/tiptap-collab-editing/app/entry.server.tsx
 create mode 100644 examples/tiptap-collab-editing/app/root.tsx
 create mode 100644 examples/tiptap-collab-editing/app/routes/editor.tsx
 create mode 100644 examples/tiptap-collab-editing/app/utils/webrtc.client.tsx
 create mode 100644 examples/tiptap-collab-editing/package.json
 create mode 100644 examples/tiptap-collab-editing/public/favicon.ico
 create mode 100644 examples/tiptap-collab-editing/remix.config.js
 create mode 100644 examples/tiptap-collab-editing/remix.env.d.ts
 create mode 100644 examples/tiptap-collab-editing/sandbox.config.json
 create mode 100644 examples/tiptap-collab-editing/tsconfig.json

diff --git a/examples/tiptap-collab-editing/.eslintrc.js b/examples/tiptap-collab-editing/.eslintrc.js
new file mode 100644
index 00000000000..ced78085f86
--- /dev/null
+++ b/examples/tiptap-collab-editing/.eslintrc.js
@@ -0,0 +1,3 @@
+module.exports = {
+  extends: ["@remix-run/eslint-config", "@remix-run/eslint-config/node"],
+};
diff --git a/examples/tiptap-collab-editing/.gitignore b/examples/tiptap-collab-editing/.gitignore
new file mode 100644
index 00000000000..3f7bf98da3e
--- /dev/null
+++ b/examples/tiptap-collab-editing/.gitignore
@@ -0,0 +1,6 @@
+node_modules
+
+/.cache
+/build
+/public/build
+.env
diff --git a/examples/tiptap-collab-editing/README.md b/examples/tiptap-collab-editing/README.md
new file mode 100644
index 00000000000..95f3d01586b
--- /dev/null
+++ b/examples/tiptap-collab-editing/README.md
@@ -0,0 +1,23 @@
+# Real time collaborative editing using tiptap and webrtc
+
+this is an example of using tiptap,yjs and webrtc to do real time collaborative editing across device and browsers
+
+## Relevent files
+
+```
+app
+├── routes
+│   └── editor.tsx // tiptab editor route
+└── utils
+    └── webrtc.client.tsx //init the webrtc, ydoc and collaboration plugin on client
+```
+
+## Preview
+
+Open this example on [CodeSandbox](https://codesandbox.com):
+
+[![Open in CodeSandbox](https://codesandbox.io/static/img/play-codesandbox.svg)](https://codesandbox.io/s/github/remix-run/remix/tree/main/examples/tiptap-collab-editing)
+
+## Related Links
+
+- [Collaborative editing – Tiptap Editor](https://tiptap.dev/guide/collaborative-editing#show-other-cursors)
diff --git a/examples/tiptap-collab-editing/app/entry.client.tsx b/examples/tiptap-collab-editing/app/entry.client.tsx
new file mode 100644
index 00000000000..3eec1fd0a02
--- /dev/null
+++ b/examples/tiptap-collab-editing/app/entry.client.tsx
@@ -0,0 +1,4 @@
+import { RemixBrowser } from "@remix-run/react";
+import { hydrate } from "react-dom";
+
+hydrate(<RemixBrowser />, document);
diff --git a/examples/tiptap-collab-editing/app/entry.server.tsx b/examples/tiptap-collab-editing/app/entry.server.tsx
new file mode 100644
index 00000000000..5afa18235cc
--- /dev/null
+++ b/examples/tiptap-collab-editing/app/entry.server.tsx
@@ -0,0 +1,21 @@
+import type { EntryContext } from "@remix-run/node";
+import { RemixServer } from "@remix-run/react";
+import { renderToString } from "react-dom/server";
+
+export default function handleRequest(
+  request: Request,
+  responseStatusCode: number,
+  responseHeaders: Headers,
+  remixContext: EntryContext
+) {
+  const markup = renderToString(
+    <RemixServer context={remixContext} url={request.url} />
+  );
+
+  responseHeaders.set("Content-Type", "text/html");
+
+  return new Response("<!DOCTYPE html>" + markup, {
+    status: responseStatusCode,
+    headers: responseHeaders,
+  });
+}
diff --git a/examples/tiptap-collab-editing/app/root.tsx b/examples/tiptap-collab-editing/app/root.tsx
new file mode 100644
index 00000000000..927a0f745df
--- /dev/null
+++ b/examples/tiptap-collab-editing/app/root.tsx
@@ -0,0 +1,32 @@
+import type { MetaFunction } from "@remix-run/node";
+import {
+  Links,
+  LiveReload,
+  Meta,
+  Outlet,
+  Scripts,
+  ScrollRestoration,
+} from "@remix-run/react";
+
+export const meta: MetaFunction = () => ({
+  charset: "utf-8",
+  title: "New Remix App",
+  viewport: "width=device-width,initial-scale=1",
+});
+
+export default function App() {
+  return (
+    <html lang="en">
+      <head>
+        <Meta />
+        <Links />
+      </head>
+      <body>
+        <Outlet />
+        <ScrollRestoration />
+        <Scripts />
+        <LiveReload />
+      </body>
+    </html>
+  );
+}
diff --git a/examples/tiptap-collab-editing/app/routes/editor.tsx b/examples/tiptap-collab-editing/app/routes/editor.tsx
new file mode 100644
index 00000000000..49dae203036
--- /dev/null
+++ b/examples/tiptap-collab-editing/app/routes/editor.tsx
@@ -0,0 +1,32 @@
+import { useEditor, EditorContent } from "@tiptap/react";
+import StarterKit from "@tiptap/starter-kit";
+import { Collaboration, ydoc, WebrtcProvider } from "~/utils/webrtc.client";
+
+if (typeof document !== "undefined") {
+  //setting the room
+  const provider = new WebrtcProvider("room-remix-example", ydoc);
+}
+export default () => {
+  let editor;
+  if (typeof document !== "undefined") {
+    editor = useEditor({
+      extensions: [
+        StarterKit.configure({
+          history: false,
+        }),
+        Collaboration.configure({
+          document: ydoc,
+        }),
+      ],
+    });
+  }
+
+  return (
+    <div>
+      <h1>Open in two browsers and see the editing in sync</h1>
+      <div style={{ border: "1px solid" }}>
+        {editor && <EditorContent editor={editor} />}
+      </div>
+    </div>
+  );
+};
diff --git a/examples/tiptap-collab-editing/app/utils/webrtc.client.tsx b/examples/tiptap-collab-editing/app/utils/webrtc.client.tsx
new file mode 100644
index 00000000000..4b38b1b0a76
--- /dev/null
+++ b/examples/tiptap-collab-editing/app/utils/webrtc.client.tsx
@@ -0,0 +1,6 @@
+import Collaboration from "@tiptap/extension-collaboration";
+import * as Y from "yjs";
+const ydoc = new Y.Doc();
+import { WebrtcProvider } from "y-webrtc";
+
+export { Collaboration, WebrtcProvider, ydoc };
diff --git a/examples/tiptap-collab-editing/package.json b/examples/tiptap-collab-editing/package.json
new file mode 100644
index 00000000000..6e2a4d80bdc
--- /dev/null
+++ b/examples/tiptap-collab-editing/package.json
@@ -0,0 +1,35 @@
+{
+  "name": "remix-example-template",
+  "private": true,
+  "description": "",
+  "license": "",
+  "sideEffects": false,
+  "scripts": {
+    "build": "remix build",
+    "dev": "remix dev",
+    "start": "remix-serve build"
+  },
+  "dependencies": {
+    "@remix-run/node": "1.3.5",
+    "@remix-run/react": "1.3.5",
+    "@remix-run/serve": "1.3.5",
+    "@tiptap/extension-collaboration": "^2.0.0-beta.33",
+    "@tiptap/react": "^2.0.0-beta.108",
+    "@tiptap/starter-kit": "^2.0.0-beta.183",
+    "react": "^17.0.2",
+    "react-dom": "^17.0.2",
+    "y-webrtc": "^10.2.2",
+    "yjs": "^13.5.34"
+  },
+  "devDependencies": {
+    "@remix-run/dev": "1.3.5",
+    "@remix-run/eslint-config": "1.3.5",
+    "@types/react": "^17.0.39",
+    "@types/react-dom": "^17.0.13",
+    "eslint": "^8.10.0",
+    "typescript": "^4.6.2"
+  },
+  "engines": {
+    "node": ">=14"
+  }
+}
diff --git a/examples/tiptap-collab-editing/public/favicon.ico b/examples/tiptap-collab-editing/public/favicon.ico
new file mode 100644
index 0000000000000000000000000000000000000000..8830cf6821b354114848e6354889b8ecf6d2bc61
GIT binary patch
literal 16958
zcmeI3+jCXb9mnJN2h^uNlXH@jlam{_a8F3W{T}Wih>9YJpaf7TUbu)A5fv|h7OMfR
zR;q$lr&D!wv|c)`wcw1?>4QT1(&|jdsrI2h`Rn)dTW5t$8pz=s3_5L?#oBxAowe8R
z_WfPfN?F+@`q$D@rvC?(W!uWieppskmQ~YG*>*L?{img@tWpnYXZslxeh#TSUS3{q
z1Ju6JcfQSbQuORq69@YK(X-3c9vC2c2a2z~zw=F=50@pm0PUiCAm!bAT?2jpM`(^b
zC|2&Ngngt^<>oCv#<S!-dX;>?P(AZ`5_84x#QBPulix)TpkIAUp=(KgGo4CVS~Sxt
zVoR4>r5g9%bDh7hi0|v$={zr>CHd`?-l4^Ld(Z9PNz9piFY+llUw_x4ou7Vf-q%$g
z)&)J4>6Ft~RZ(uV>dJD<Ri@O+ttLaCvYPyTPWL>|`nxI1^x{X<kw8nThj+Y}tw{Or
zRjUv4hrU{KGhbGHm9Ho8JkC+BwU&#I{n0PFy7kVfbG?_+T+m-3nxQ?DUla7zinfMq
z%7#>@Z5S<=vf;V3w_(*O-7}W<=e$=}CB9_R;)m9)d7`d_xx+nl^Bg|%ew=?uoKO8w
zeQU7h;~8s!@9-k>7Cx}<bJ3N5)-UEEpLCvfc#RzR<`8{*xab{Oo3=4^71mT=VdDqW
z($=D$#(h&m+Q#bHD81KM6L?WCy3h+`$eLs0K9?!C`fS>1<o!{ao8ND$Pg}FkS7GCH
zJw}ah!*h61t2v#otd%vZ6+nN#?=TPYL0-^ar*$LiQFUQGZ9^+;N@Jx>SDQ7m(&miH
zs8!l*wOJ!GHbdh)pD--&W3+w`9YJ=;m^FtMY=`mTq8pyV!-@L6smwp3(q?G>=_4v^
zn(ikLue7!y70#2uhqUVpb7fp!=xu2{aM^1P^pts#+feZv8d~)2sf`sjXLQCEj;pdI
z%~f`JOO;*KnziMv^i_6+?mL?^wrE_&=IT9o1i!}Sd4Sx4O@w~1bi1)8<?^1W_hyQJ
z^TuRsvF7h=(){B?>(sXvYR-1?7~Zr<=SJ1Cw!i~yfi=4h6o3O~(-Sb2Ilwq%g$+V`
z>(C&N1!FV5rWF&iwt8~b)=jIn4b!XbrWrZgIHTISrdHcpjjx=TwJXI7_%Ks4oFLl9
zNT;!%!P4~xH85njXdfqgnIxIFOOKW`W$fxU%{{5wZkVF^G=JB$oUNU5dQSL&ZnR1s
z*ckJ$R`eCUJsWL>j6*+|2S1TL_J|Fl&kt=~XZF=+=iT0Xq1*KU-NuH%NAQff$LJp3
zU_*a;@7I0K{mqwux87~vwsp<}@P>KNDb}3U+6$rcZ114|QTMUSk+rhPA(b{$>pQTc
zIQri{+U>GMzsCy0Mo4BfWXJlkk;RhfpWpAB{=Rtr*d1MNC+H3Oi5+3D$gUI&AjV-1
z=0Z<L3zM*4u<g-e=|9$O^MnPHwN`w?DDl)WJ}-Op{;HO&ee}ljeagQt`n!MJWs7Ai
z;3B>Oox+bGyHe=yk-yu%=+{~&46C$ut^ZN+ysx$NH}*F43)3bKkMsxGyIl#>7Yb8W
zO{}&LUO8Ow{7>!bvSq?X{15&Y|4}0w2=o_^0ZzYgB+4HhZ4>s*mW&?RQ6&AY|CPcx
z$*LjftNS|H)ePYnIKNg{ck*|y7EJ&Co0ho0K`!{ENPkASeKy-JWE}dF_%}j)Z5a&q
zXAI2gPu6`s-@baW=*+keiE$A<b_MR?C-5PseqT8KkKDY(u92UZE4^yfJYZmLRl0Qj
z2mi$bu(VF|VOOk`m}JGAX2-zC@9eU}cdfT)cCWW1_iV7|_H3}{?+yJCT{HgFuJ!hW
z-dneDylkh+V;A%t9|&GGNe?DVALeWQ(D9>LIs5G6_X_6kgKK8n3jH2-H9`6bo)Qn1
zZ2x)xPt1=`9V|bE4*;j9$X20+xQCc$rEK<k`Fi~Hjq>|9OwH-O+Q*k`ZNw}K##SkY
z3u}aCV%V|j@!gL5(*5fuWo>JFjeU9Qqk`$bdwH8(qZovE2tA7WUpoCE=VKm^eZ|vZ
z(k<+j*mGJVah>8CkAsMD6#I$RtF;#57Wi`c_^k5?+KCmX$;Ky2*6<J=fcB~4B|ZV&
z?~?BCTu@_QfA&ei^lx3%=--_q{3EVljTZ#}J^n$D1~~>|Q^bJ8+s%2MB}OH-g$Ev^
zO3uqfGjuN%CZiu<`aCuKCh{kK!dDZ+<Fl~arF!o=>CcwgIeU2dsDfz+V>V3BDb~)~
zO!2l!_)m;ZepR~sL+-~s<YrF4FaR4!(myY+152d8&=KNvctHGLWgQw{tVX<yoWW_Z
zj-Hr!ndH7odVllGob8-nW3NBFv0(bY`1FL^9N&SL;FHHcq95!k&HtnS;-hG%hCy5j
z26`MMf5rEpW07<ly2*EzOXtyjasql9V^`87BWQ&$%XE#tlN;dgHVN~f{lTSm_O}mT
zE0})bgjJdY-h#`-)Z`P?PD;&z;T?03pC|DTyTxXaAF{>HS7;5ZB|~uUM&&5vDda2b
z)CW8S6GI*oF><|ZeY5D^+Mcsri)!tmrM33qvwI4r9o@(GlW!u2R>>sB|E#%W`c*@5
z|0iA|`{6aA7D4Q?vc1{vT-#yytn07`H!QIO^1+X7?zG3%y0<K~L$`F=p)E9B=Nsdp
zb=qM)|Jkjbc68S&dsX^=;-v%j)u|KbMf(>gPdIPUJ#s*DNAwd}m1_IMN1^T&be~+E
z_z%1W^9~dl|Me9U6+3oNyuMDkF*z_;dOG(Baa*yq;TRiw{EO~O_S6>e*L(+Cdu(TM
z@o%xTCV%hi&p)x3_inIF!b|W4|AF5p?y1j)cr9RG@v%QVaN8&LaorC-kJz_ExfVHB
za!mtuee#Vb?dh&bwrfGHYAiX&&|v$}U*UBM;#F!N=x>x|G5s0zOa9{(`=k4v^6iK3
z8d&=O@xhDs{;v7<i<J%blPl`%F2zV2g`fBkaG1Pogz882RUuz5)%QjDQ|qVROU;s)
z&2zMiK!4P)&yT-qFYjDtyBF5F{*y1vPxwCS6y&Rpe_)teF|v>JQ%eO;!Bt`&*MH&d
zp^K#dkq;jnJz%%bsqwlaKA5<gd^+Mkxi7IxDK-%BFT|4IAN4BoH1O}I%ID%*E>?fy
zS5JDbO#BgSAdi8<E3bcf{8u~%MEaSFm@4?cP}e`Oy}11ULi6hN?%l2f)C{Mn9*>NM
zDo2SifX6^Z;vn>cBh-?~r_n9qYvP|3ihrnqq6deS-#>l#dV4mX|G%L8|EL;$U+w69
z;rTK3FW$ewUfH|R-Z;3;jvpfiDm?Fvyu9PeR>wi|E8>&j2Z@2h`U}|$><c4e{h$1w
z{FfRq@#VNY57^%!w<Fg>2d`BPV3pz#ViIzH8v6pP^L-p!GbLv<;(p>}_6u&E6XO5-
zJ8JEvJ1)0>{iSd|kOQn#?0rTYL=KSmgMHCf$Qbm;7|8d(goD&T-~oCDuZf57iP#_Y
zmxaoOSjQsm*^u+m$L9AMqwi=6bpdiAY6k3akjGN{xOZ`_J<~Puyzpi7yhhKrLmXV;
z@ftONPy;Uw1F#{_fyGbk04yLE01v=i_5`RqQP+SUH0nb=O?l!J)qCSTdsbmjFJrTm
zx4^ef@qt{B+TV_OHOhtR?XT}1Etm(f21;#qyyW6FpnM+S7*M1iME?9fe8d-`Q#InN
z?^y{C_|8bxgUE@!o+Z72C)BrS&5D`gb-X8kq*1G7Uld-z19V}HY~mK#!o9MC-*#^+
znEsdc-|jj0+%cgBMy(cEkq4IQ1D*b;17Lyp>Utnsz%LRTfjQKL*vo(yJxwtw^)l|!
z7jhIDdtLB}m<l{aZcDUR3Vu-k+`XvA-r9dt!Sv$?zyM+)c*=UnSwkF9d<+EdBK`0Z
zOvSg<Db557lC(Q*`Yt{Kj07Xt>pkOIG&4@F+9cYkS5r%%jz}I0R#F4oBMf-|Jmmk*
zk^OEzF%}%5{a~kGYbFjV1n>HKC+a`;&-n*v_kD2DPP~n5(QE3C;30L<32GB*qV2z$
zWR1Kh=^1-q)P37WS6YWKlUSDe=eD^u_CV+P)q!3^{=$#b^auG<yDY{2eGgE&A8BtO
z4iN3=GdAq!6NGK#1^8e5z+BOTJyYw8ZN6Vq<F5*1vQvB~xg>S7m8zFfFS<>(e~)TG
z&uwWhSoetoe!1^<uYo6XVYh$jYq2>%)O}=6{SUcw-UQmw+i8lokRASPsbT=H|4D|(
zk^P7>TUEFho!3qXSWn$<jp767-aNC~whQ<7bkx~XU6anc7IYxL2j=)Mxg_x)9qvoF
z`x}FAA^ubCS9(wUhmE&MfARUmoSgHZc6;O0te<(<Bs#F)Ewf{<YvCDVx6mZtTa~xm
zriQQIAzi=kic!|RagNu)PQFvP&x`TjzqMDed4BN!oRJwP`eO||`2Qm5kC>m2{lHXw
zD>eN6-;wwq9(?@f^F4L2Ny5_6!d~iiA^s~(|B*lbZir-$&%)l>%Q(36yOIAu|326K
ztmBWz|MLA{Kj(H_{w2gd*nZ6a@ma(w==~EHIscEk|C=NGJa%Ruh4_+~f|%rt{I5v*
zIX@F?|KJID56-ivb+PLo(9hn_CdK{irOcL15>JNQFY112^$+}JPyI{uQ~$&E*=ri;
z`d^fH?4f=8vKHT4!p9O*fX(brB75Y9?e>T9=X#Fc@V#%@5^)~#zu5I(=>LQA-EGTS
zecy*#6gG+8lapch#Hh%vl(+}J;Q!hC1OKoo;#h3#V%5Js)tQ)|>pTT@1ojd+F9Gey
zg`B)zm`|Mo%tH31<UKv~=W{;tJ>s4=<+`Pu|B3orXwNyIcNN>;fBkIj^X8P}RXhF=
zXQK1u5RLN7k#_Q(KznJrALtMM13!vhfr025ar?@-%{l|uWt@NEd<$~n><jfS>RQL{
z+o;->n)+~0tt(u|o_9h!T`%M8%)w2awpV9b*xz9Pl-daUJm3y-HT%xg`^mFd6LBeL
z!0~s;zEr)Bn9x)I(wx`;JVwvRcc^io2XX(Nn3vr3dgbrr@YJ?K3w18P*52^ieBCQP
z=Up1V$N2~5ppJHRTeY8QfM(7Yv&RG7oWJAy<l59ZkqbHxP9b+_2e(SqeV4yuK)@1s
z%lQX#-VwqX^njWV_Q$z9&VW$+qSn=+HB*x>v?c3g(29)P)u;_o&w|&)HGDIinXT~p
z3;S|e$=&Tek9Wn!`cdY+d-w@o`37}x{(hl>ykB|%9yB$CGdIcl7Z?d&lJ%}QHck77
zJPR%C+s2w1_Dl_pxu6$Zi!`HmoD-%7OD@7%lKLL^Ixd9VlRSW*o&$^iQ2z+}hTgH)
z#91TO#+jH<`w4L}XWOt(`gqM*uTUcky`O(mEyU|4dJoy6*UZJ7%*}ajuos%~>&P2j
zk23f5<@GeV?(?`l=ih+D8t`d72xrUjv0wsg;%s1@*2p?TQ;n2$pV7h?_T%sL>iL@w
zZ{lmc<|B7!e&o!zs6RW+u8+aDyUdG>ZS(v&rT$QVymB7sEC@VsK1dg^3F@K90-wYB
zX!we79q<?(Wh~izEdPF0&->x`(6LA>F$~{{xE8-3Wzyfe`+Lsce(?uj{k@lb9<ViF
zY+O(5$+i4C_V5c{<+16E=ROu{Q$6GPT4S6q&{_K5u_V`@ycX##{0*QmV{dZ2nCqY;
zA?8S4GZ*)9&c3dbWAVLjyN70I=SO__U;F#l<Io(a5C3z2A@tzemRqUwLt}5+d-0(~
z@9;OFU}KNoe$TIui>7YTJt#>l*Z&LyKX@zjmu?UJC9w~;|NsB{%7G}y*uNDBxirfC
EKbET!0{{R3

literal 0
HcmV?d00001

diff --git a/examples/tiptap-collab-editing/remix.config.js b/examples/tiptap-collab-editing/remix.config.js
new file mode 100644
index 00000000000..1755894599a
--- /dev/null
+++ b/examples/tiptap-collab-editing/remix.config.js
@@ -0,0 +1,10 @@
+/**
+ * @type {import('@remix-run/dev').AppConfig}
+ */
+module.exports = {
+  ignoredRouteFiles: [".*"],
+  // appDirectory: "app",
+  // assetsBuildDirectory: "public/build",
+  // serverBuildPath: "build/index.js",
+  // publicPath: "/build/",
+};
diff --git a/examples/tiptap-collab-editing/remix.env.d.ts b/examples/tiptap-collab-editing/remix.env.d.ts
new file mode 100644
index 00000000000..72e2affe311
--- /dev/null
+++ b/examples/tiptap-collab-editing/remix.env.d.ts
@@ -0,0 +1,2 @@
+/// <reference types="@remix-run/dev" />
+/// <reference types="@remix-run/node/globals" />
diff --git a/examples/tiptap-collab-editing/sandbox.config.json b/examples/tiptap-collab-editing/sandbox.config.json
new file mode 100644
index 00000000000..4363d87a30d
--- /dev/null
+++ b/examples/tiptap-collab-editing/sandbox.config.json
@@ -0,0 +1,6 @@
+{
+  "hardReloadOnChange": true,
+  "container": {
+    "port": 3000
+  }
+}
diff --git a/examples/tiptap-collab-editing/tsconfig.json b/examples/tiptap-collab-editing/tsconfig.json
new file mode 100644
index 00000000000..749e4b959e8
--- /dev/null
+++ b/examples/tiptap-collab-editing/tsconfig.json
@@ -0,0 +1,20 @@
+{
+  "include": ["remix.env.d.ts", "**/*.ts", "**/*.tsx"],
+  "compilerOptions": {
+    "lib": ["DOM", "DOM.Iterable", "ES2019"],
+    "isolatedModules": true,
+    "esModuleInterop": true,
+    "jsx": "react-jsx",
+    "moduleResolution": "node",
+    "resolveJsonModule": true,
+    "target": "ES2019",
+    "strict": true,
+    "baseUrl": ".",
+    "paths": {
+      "~/*": ["./app/*"]
+    },
+
+    // Remix takes care of building everything in `remix build`.
+    "noEmit": true
+  }
+}

From 83b987026cf2aa9760a8143dcb6ddde415ce27eb Mon Sep 17 00:00:00 2001
From: Marvin Wu <marvinwu@gmail.com>
Date: Fri, 15 Apr 2022 11:11:37 +0800
Subject: [PATCH 2/2] fixed linting error

---
 examples/tiptap-collab-editing/README.md                   | 3 ++-
 examples/tiptap-collab-editing/app/routes/editor.tsx       | 4 ++--
 examples/tiptap-collab-editing/app/utils/webrtc.client.tsx | 2 +-
 3 files changed, 5 insertions(+), 4 deletions(-)

diff --git a/examples/tiptap-collab-editing/README.md b/examples/tiptap-collab-editing/README.md
index 95f3d01586b..52e1a4f9970 100644
--- a/examples/tiptap-collab-editing/README.md
+++ b/examples/tiptap-collab-editing/README.md
@@ -7,7 +7,7 @@ this is an example of using tiptap,yjs and webrtc to do real time collaborative
 ```
 app
 ├── routes
-│   └── editor.tsx // tiptab editor route
+│   └── editor.tsx // tiptab editor route, open it in different browser to see the changes get sync
 └── utils
     └── webrtc.client.tsx //init the webrtc, ydoc and collaboration plugin on client
 ```
@@ -21,3 +21,4 @@ Open this example on [CodeSandbox](https://codesandbox.com):
 ## Related Links
 
 - [Collaborative editing – Tiptap Editor](https://tiptap.dev/guide/collaborative-editing#show-other-cursors)
+- [Remix | Module Constraints](https://remix.run/docs/en/v1/guides/constraints#document-guard)
diff --git a/examples/tiptap-collab-editing/app/routes/editor.tsx b/examples/tiptap-collab-editing/app/routes/editor.tsx
index 49dae203036..4a7ec8d0880 100644
--- a/examples/tiptap-collab-editing/app/routes/editor.tsx
+++ b/examples/tiptap-collab-editing/app/routes/editor.tsx
@@ -3,8 +3,8 @@ import StarterKit from "@tiptap/starter-kit";
 import { Collaboration, ydoc, WebrtcProvider } from "~/utils/webrtc.client";
 
 if (typeof document !== "undefined") {
-  //setting the room
-  const provider = new WebrtcProvider("room-remix-example", ydoc);
+  //join the room remix example
+  new WebrtcProvider("room-remix-example", ydoc);
 }
 export default () => {
   let editor;
diff --git a/examples/tiptap-collab-editing/app/utils/webrtc.client.tsx b/examples/tiptap-collab-editing/app/utils/webrtc.client.tsx
index 4b38b1b0a76..bad914b518b 100644
--- a/examples/tiptap-collab-editing/app/utils/webrtc.client.tsx
+++ b/examples/tiptap-collab-editing/app/utils/webrtc.client.tsx
@@ -1,6 +1,6 @@
 import Collaboration from "@tiptap/extension-collaboration";
 import * as Y from "yjs";
-const ydoc = new Y.Doc();
 import { WebrtcProvider } from "y-webrtc";
+const ydoc = new Y.Doc();
 
 export { Collaboration, WebrtcProvider, ydoc };