|
| 1 | +const detailsContent = String.raw` |
| 2 | +--- |
| 3 | +
|
| 4 | +**CollabyDraw** is a web-based collaborative whiteboard where multiple users can draw, edit, and brainstorm together in real time. Whether solo or in a group session, the app offers a smooth, intuitive canvas experience with real-time sync, shape tools, editable text, and privacy-focused end-to-end encryption — all without needing an account. |
| 5 | +
|
| 6 | +--- |
| 7 | +
|
| 8 | +### ✅ Core Features |
| 9 | +
|
| 10 | +- **Canvas Drawing**: Freehand, shapes, and editable text |
| 11 | +- **Rough.js Support**: Optional sketch-style drawing |
| 12 | +- **Perfect-freehand Support**: Hand drawn feel |
| 13 | +- **Eraser Tool**: Remove individual shapes |
| 14 | +- **Editable Text**: Double-click to edit on canvas |
| 15 | +
|
| 16 | +--- |
| 17 | +
|
| 18 | +### 🔗 Collaboration |
| 19 | +
|
| 20 | +- **Real-time Sync**: WebSocket-powered live drawing |
| 21 | +- **Multi-Tab Awareness**: No duplicate join/leave events |
| 22 | +- **Optimistic Updates**: Instant feedback before server response |
| 23 | +
|
| 24 | +--- |
| 25 | +
|
| 26 | +### 🔐 Privacy & End-to-End Encryption (E2EE) in CollabyDraw |
| 27 | +
|
| 28 | +CollabyDraw is built with **privacy by design** to ensure that no sensitive drawing data can be accessed by anyone other than the intended participants. |
| 29 | +
|
| 30 | +#### 🔑 How It Works |
| 31 | +
|
| 32 | +When a user creates or joins a room, the app generates a link like: |
| 33 | +
|
| 34 | +\`\`\` |
| 35 | +https://collabydraw.app/#room=abc123,xyz456 |
| 36 | +\`\`\` |
| 37 | +
|
| 38 | +- \`abc123\`: Unique room ID (used by the server) |
| 39 | +- \`xyz456\`: Encryption key (used **only** on the client) |
| 40 | +
|
| 41 | +--- |
| 42 | +
|
| 43 | +#### 🧠 Key Never Touches the Server |
| 44 | +
|
| 45 | +- The **encryption key** after the comma (\`xyz456\`) is part of the URL fragment (\`#...\`) |
| 46 | +- This fragment is **never sent** in HTTP requests, meaning: |
| 47 | +
|
| 48 | +> The server cannot see or store the encryption key. |
| 49 | +
|
| 50 | +--- |
| 51 | +
|
| 52 | +#### 🔒 Client-Side Only Decryption |
| 53 | +
|
| 54 | +- All encrypted drawing data is transmitted over WebSocket |
| 55 | +- The **decryption and rendering** happen completely on the client-side using the \`key\` from the URL |
| 56 | +- Even if someone intercepts the WebSocket traffic, they cannot decrypt the data without the key |
| 57 | +
|
| 58 | +--- |
| 59 | +
|
| 60 | +#### 🛡️ Benefits |
| 61 | +
|
| 62 | +- No one — not even the server — can read what’s drawn in a room without the key |
| 63 | +- Ensures **confidentiality** for private brainstorming, teaching, or design sessions |
| 64 | +- Works like **Excalidraw's E2EE rooms**, but tailored for your collaborative drawing logic |
| 65 | +
|
| 66 | +--- |
| 67 | +
|
| 68 | +### 🧠 Reliability |
| 69 | +
|
| 70 | +- **Message Queue**: Stores unsent messages in memory/localStorage |
| 71 | +- **Auto Retry**: Flushes queued messages on reconnect |
| 72 | +
|
| 73 | +--- |
| 74 | +
|
| 75 | +### 🧭 Modes |
| 76 | +
|
| 77 | +- **Standalone Mode**: Offline/local drawing |
| 78 | +- **Room Mode**: Collaborative sessions |
| 79 | +
|
| 80 | +--- |
| 81 | +
|
| 82 | +### ⚙️ Tech Stack |
| 83 | +
|
| 84 | +- **Frontend**: React (Vite), TypeScript, Tailwind CSS |
| 85 | +- **Canvas**: HTML Canvas API + Custom Engine |
| 86 | +- **Realtime**: Native WebSocket (\`useWebSocket\` hook) |
| 87 | +- **Security**: Hash-based E2EE |
| 88 | +
|
| 89 | +--- |
| 90 | +
|
| 91 | +### 📂 Github Repo |
| 92 | +
|
| 93 | +[github.com/coderomm/CollabyDraw](https://github.com/coderomm/CollabyDraw) |
| 94 | +
|
| 95 | +--- |
| 96 | +
|
| 97 | +### 📽️ YouTube Demo |
| 98 | +
|
| 99 | +<iframe width="100%" height="400" src="https://www.youtube.com/embed/NNVdRCoFnK0" frameborder="0" allowfullscreen></iframe> |
| 100 | +
|
| 101 | +--- |
| 102 | +
|
| 103 | +### 🐦 Tweet Embed |
| 104 | +
|
| 105 | +<Tweet id="1711737824058880576" /> |
| 106 | +
|
| 107 | +`; |
| 108 | + |
| 109 | +export default detailsContent; |
0 commit comments