|
Download README.md from myagent10101/codesync-collaborative-platform: direct link, hf CLI and curl.
- Browser
- Download file 10.6 kB
-
https://huggingface.co/myagent10101/codesync-collaborative-platform/resolve/main/README.md
- Command line
-
hf download hf://myagent10101/codesync-collaborative-platform/README.md
-
curl -L -o README.md https://huggingface.co/myagent10101/codesync-collaborative-platform/resolve/main/README.md
10.6 kB
| tags: | |
| - ml-intern | |
| # π CodeSync β Real-Time Collaborative Coding Platform | |
| <div align="center"> | |
|  | |
|  | |
|  | |
|  | |
|  | |
|  | |
| **A production-grade multiplayer code editor with AI assistance, video collaboration, and sandboxed execution.** | |
| [Live Demo](#) β’ [Documentation](./docs/ARCHITECTURE.md) β’ [Deployment Guide](./docs/DEPLOYMENT.md) | |
| </div> | |
| --- | |
| ## β¨ Features | |
| ### π Real-Time Collaboration | |
| - **CRDT-based sync** (Yjs) β conflict-free concurrent editing | |
| - **Cursor presence** β see where teammates are typing | |
| - **Typing indicators** β know when someone is active | |
| - **Optimistic updates** β instant local feedback, async server sync | |
| ### π Monaco Editor | |
| - VS Code-grade editing experience | |
| - Multi-language syntax highlighting | |
| - IntelliSense auto-completion | |
| - File explorer + tab system | |
| - Customizable themes (Dark, Light, High Contrast) | |
| - Keyboard shortcuts (Ctrl+S, Ctrl+Z, etc.) | |
| ### π Rooms System | |
| - Create/join coding rooms | |
| - Shareable invite links | |
| - Role-based access control (Owner / Editor / Viewer) | |
| - Persistent room state across sessions | |
| ### π¬ Real-Time Chat | |
| - Room messaging with typing indicators | |
| - Code snippet sharing | |
| - Emoji support | |
| - Message persistence | |
| ### β‘ Code Execution | |
| - **Docker sandbox isolation** β secure execution | |
| - Multi-language: JavaScript, Python, C++, Java | |
| - Resource limits (CPU, memory, time) | |
| - Real-time output streaming | |
| - Network isolation (prevents malicious code) | |
| ### πΉ Video/Audio Calls | |
| - WebRTC peer-to-peer connections | |
| - Screen sharing | |
| - Mute/unmute controls | |
| - Connection quality indicators | |
| ### π€ AI Assistant | |
| - Powered by OpenRouter (Gemini, GPT-4, Claude) | |
| - Explain code / errors | |
| - Suggest fixes | |
| - Optimize performance | |
| - Generate documentation | |
| - Context-aware debugging | |
| ### π Authentication | |
| - JWT-based auth (access + refresh tokens) | |
| - Google OAuth integration | |
| - Protected routes | |
| - Session persistence | |
| --- | |
| ## ποΈ Architecture | |
| ``` | |
| βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ | |
| β Client (Next.js 14) β | |
| β Monaco Editor β Socket.io β WebRTC β Zustand β Tailwind β | |
| βββββββββββββββββββββββββββββ¬ββββββββββββββββββββββββββββββββββ | |
| β WebSocket + REST | |
| βββββββββββββββββββββββββββββ΄ββββββββββββββββββββββββββββββββββ | |
| β Backend (Express + Socket.io) β | |
| β REST API β CRDT Engine β WebRTC Signaling β Execution Queue β | |
| βββββββ¬βββββββββββββββ¬βββββββββββββββββββββββββββββ¬ββββββββββββ | |
| β β β | |
| βββββββ΄ββββββ βββββββ΄ββββββ ββββββββββ΄βββββββββ | |
| β PostgreSQL β β Upstash β β Docker Sandboxes β | |
| β (Supabase) β β Redis β β (Isolated) β | |
| βββββββββββββ βββββββββββββ βββββββββββββββββββ | |
| ``` | |
| ### Key Design Decisions | |
| | Decision | Rationale | | |
| |----------|-----------| | |
| | **Yjs (CRDT)** over OT | No central authority needed; guaranteed convergence; used by Notion & JupyterLab | | |
| | **Redis Pub/Sub** | Enables horizontal scaling without sticky sessions | | |
| | **Zustand** over Redux | Less boilerplate, better TS support, sufficient for our needs | | |
| | **Docker Isolation** | Security-first execution with resource limits and network isolation | | |
| | **Upstash Redis** | Serverless-friendly, free tier, REST + pub/sub support | | |
| --- | |
| ## π Quick Start | |
| ### Prerequisites | |
| - Node.js β₯ 20 | |
| - pnpm β₯ 9 | |
| - Docker (for code execution) | |
| - PostgreSQL (or Docker) | |
| ### Setup | |
| ```bash | |
| # Clone the repository | |
| git clone https://github.com/yourusername/codesync.git | |
| cd codesync | |
| # Install dependencies | |
| pnpm install | |
| # Set up environment variables | |
| cp apps/server/.env.example apps/server/.env | |
| # Edit .env with your values | |
| # Start database | |
| docker compose -f docker/docker-compose.yml up postgres redis -d | |
| # Run database migrations | |
| cd apps/server && npx prisma migrate dev | |
| # Build sandbox images (for code execution) | |
| cd ../../docker/sandboxes | |
| docker build -t codesync-sandbox-js ./javascript | |
| docker build -t codesync-sandbox-python ./python | |
| # Start development servers | |
| cd ../.. | |
| pnpm dev | |
| ``` | |
| ### Access | |
| - Frontend: http://localhost:3000 | |
| - Backend: http://localhost:4000 | |
| - API Health: http://localhost:4000/api/health | |
| --- | |
| ## π Project Structure | |
| ``` | |
| codesync/ | |
| βββ apps/ | |
| β βββ web/ # Next.js 14 frontend | |
| β β βββ src/ | |
| β β β βββ app/ # App Router pages | |
| β β β βββ components/ # React components | |
| β β β βββ hooks/ # Custom hooks (useSocket, useWebRTC, etc.) | |
| β β β βββ stores/ # Zustand state management | |
| β β β βββ lib/ # Utilities (CRDT, API, WebRTC) | |
| β β β βββ types/ # TypeScript definitions | |
| β β βββ ... | |
| β βββ server/ # Express backend | |
| β βββ src/ | |
| β β βββ config/ # Environment, Redis, Database | |
| β β βββ middleware/ # Auth, rate limiting, security | |
| β β βββ routes/ # REST API endpoints | |
| β β βββ services/ # Business logic | |
| β β βββ socket/ # WebSocket handlers | |
| β β βββ utils/ # Helpers (JWT, logger, errors) | |
| β βββ prisma/ # Database schema + migrations | |
| βββ packages/ | |
| β βββ shared/ # Shared types & constants | |
| βββ docker/ # Docker configs + sandboxes | |
| βββ docs/ # Architecture & deployment docs | |
| ``` | |
| --- | |
| ## π WebSocket Events | |
| | Event | Direction | Description | | |
| |-------|-----------|-------------| | |
| | `room:join` | Client β Server | Join a coding room | | |
| | `room:joined` | Server β Client | Room data + initial state | | |
| | `doc:update` | Client β Server | CRDT document delta | | |
| | `doc:sync` | Server β Client | Broadcast delta to others | | |
| | `cursor:move` | Client β Server | Cursor position update | | |
| | `cursor:update` | Server β Client | Remote cursor positions | | |
| | `chat:send` | Client β Server | Send chat message | | |
| | `chat:message` | Server β Client | Broadcast message | | |
| | `exec:run` | Client β Server | Execute code | | |
| | `exec:output` | Server β Client | Streaming execution output | | |
| | `webrtc:offer` | Client β Server | WebRTC SDP offer relay | | |
| | `webrtc:answer` | Server β Client | WebRTC SDP answer relay | | |
| | `webrtc:ice-candidate` | Both | ICE candidate exchange | | |
| --- | |
| ## π Security | |
| - **Docker Sandbox**: Network-disabled containers with CPU/memory limits | |
| - **JWT Authentication**: Short-lived access tokens + refresh rotation | |
| - **Rate Limiting**: Redis-backed distributed rate limiting | |
| - **XSS Protection**: Input sanitization + Helmet headers | |
| - **CORS**: Strict origin validation | |
| - **Non-root Execution**: Sandbox containers run as unprivileged users | |
| --- | |
| ## π Performance | |
| - **CRDT Sync**: ~5ms latency for character-level updates | |
| - **WebSocket**: Binary protocol for minimal overhead | |
| - **Debounced Sync**: Batches rapid keystrokes before broadcast | |
| - **Redis Caching**: Room metadata + recent messages cached | |
| - **Optimistic UI**: Local changes applied instantly | |
| --- | |
| ## π οΈ Tech Stack | |
| | Layer | Technology | | |
| |-------|-----------| | |
| | Frontend | Next.js 14, TypeScript, Tailwind CSS | | |
| | Editor | Monaco Editor (VS Code engine) | | |
| | State | Zustand | | |
| | Real-time | Socket.io, Yjs (CRDT) | | |
| | Video | WebRTC | | |
| | Backend | Node.js, Express | | |
| | Database | PostgreSQL (Prisma ORM) | | |
| | Cache | Upstash Redis | | |
| | Execution | Docker containers | | |
| | AI | OpenRouter (multi-model) | | |
| | Auth | JWT + Google OAuth | | |
| | Deploy | Vercel + Railway | | |
| --- | |
| ## π Scalability | |
| The architecture supports horizontal scaling out of the box: | |
| 1. **Multiple server instances** share state via Redis pub/sub | |
| 2. **No sticky sessions** required β any instance can handle any request | |
| 3. **CRDT convergence** guarantees consistency without coordination | |
| 4. **Connection pooling** via PgBouncer for database efficiency | |
| 5. **Queue-based execution** prevents overload during high traffic | |
| --- | |
| ## π€ Contributing | |
| 1. Fork the repository | |
| 2. Create a feature branch (`git checkout -b feature/amazing-feature`) | |
| 3. Commit your changes (`git commit -m 'Add amazing feature'`) | |
| 4. Push to the branch (`git push origin feature/amazing-feature`) | |
| 5. Open a Pull Request | |
| --- | |
| ## π License | |
| MIT License β see [LICENSE](./LICENSE) for details. | |
| --- | |
| <div align="center"> | |
| <b>Built with β€οΈ demonstrating distributed systems, real-time sync, and collaborative architecture.</b> | |
| </div> | |
| <!-- ml-intern-provenance --> | |
| ## Generated by ML Intern | |
| This model repository was generated by [ML Intern](https://github.com/huggingface/ml-intern), an agent for machine learning research and development on the Hugging Face Hub. | |
| - Try ML Intern: https://smolagents-ml-intern.hf.space | |
| - Source code: https://github.com/huggingface/ml-intern | |
| ## Usage | |
| ```python | |
| from transformers import AutoModelForCausalLM, AutoTokenizer | |
| model_id = 'myagent10101/codesync-collaborative-platform' | |
| tokenizer = AutoTokenizer.from_pretrained(model_id) | |
| model = AutoModelForCausalLM.from_pretrained(model_id) | |
| ``` | |
| For non-causal architectures, replace `AutoModelForCausalLM` with the appropriate `AutoModel` class. | |