https://github.com/02muskan/code-sync
Code Sync is a full-stack, real-time collaborative coding platform where multiple users can code together, chat live, and collaborate seamlessly.
https://github.com/02muskan/code-sync
docker expressjs nodejs react react-router socket-io tailwind-css tyoescript
Last synced: about 2 months ago
JSON representation
Code Sync is a full-stack, real-time collaborative coding platform where multiple users can code together, chat live, and collaborate seamlessly.
- Host: GitHub
- URL: https://github.com/02muskan/code-sync
- Owner: 02Muskan
- License: mit
- Created: 2025-07-08T16:20:20.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-08T17:05:12.000Z (11 months ago)
- Last Synced: 2025-07-08T17:41:07.908Z (11 months ago)
- Topics: docker, expressjs, nodejs, react, react-router, socket-io, tailwind-css, tyoescript
- Language: TypeScript
- Homepage: https://code-sync-eight-tau.vercel.app/editor/ea1d423a-be38-4d2a-b0ba-ee515fc2cf15
- Size: 342 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
## 🔮 Features
- 💻 Real-time collaboration on code editing across multiple files
- 📁 Create, open, edit, save, delete, and organize files and folders
- 💾 Option to download the entire codebase as a zip file
- 🚀 Unique room generation with room ID for collaboration
- 🌍 Comprehensive language support for versatile programming
- 🌈 Syntax highlighting for various file types with auto-language detection
- 🚀 Code Execution: Users can execute the code directly within the collaboration environment
- ⏱️ Instant updates and synchronization of code changes across all files and folders
- 📣 Notifications for user join and leave events
- 👥 User presence list with online/offline status indicators
- 💬 Real-time group chatting functionality
- 🎩 Real-time tooltip displaying users currently editing
- 💡 Auto suggestion based on programming language
- 🔠 Option to change font size and font family
- 🎨 Multiple themes for personalized coding experience
- 🎨 Collaborative Drawing: Enable users to draw and sketch collaboratively in real-time
- 🤖 Copilot: An AI-powered assistant that generates code, allowing you to insert, copy, or replace content seamlessly within your files.
## 🚀 Live Preview
You can view the live preview of the project [here](https://code-sync-live.vercel.app/).
## 💻 Tech Stack
## ⚙️ Installation
### Method 1: Manual Installation
1. **Fork this repository:** Click the Fork button located in the top-right corner of this page.
2. **Clone the repository:**
```bash
git clone https://github.com//Code-Sync.git
```
3. **Create .env file:**
Inside the client and server directories create `.env` and set:
Frontend:
```bash
VITE_BACKEND_URL=
```
Backend:
```bash
PORT=3000
```
4. **Install dependencies:**
```bash
npm install # Run in both client and server directories
```
5. **Start the servers:**
Frontend:
```bash
cd client
npm run dev
```
Backend:
```bash
cd server
npm run dev
```
6. **Access the application:**
```bash
http://localhost:5173/
```
### Method 2: Docker Installation
1. **Install Docker Desktop:**
- Download and install **Docker Desktop** from [Docker’s official website](https://www.docker.com/products/docker-desktop/).
- Verify installation:
```bash
docker --version
```
```
```
2. **Access the application:**
```bash
http://localhost:5173/
```
## 🔮 Features for Next Release
- **Admin Permission:** Implement an admin permission system to manage user access levels and control over certain platform features.
## 🤝 Contribute
We welcome contributions to make Code Sync even better! Follow the [contribution guidelines](CONTRIBUTING.md) to get started.
## 🌟 Support Us
If you find this helpful or valuable, please consider 🌟 starring the repository. It helps us gain visibility and encourages further development.
## 🧾 License
This project is licensed under the [MIT License](LICENSE).
## 🌟 Appreciation for Resources
Special thanks to:
- EMKC for providing the Piston API:
- [Piston Repository](https://github.com/engineer-man/piston)
- [Piston Docs](https://piston.readthedocs.io/en/latest/api-v2/)
- Tldraw contributors:
- [Tldraw Repository](https://github.com/tldraw/tldraw)
- [Tldraw Documentation](https://tldraw.dev/)
- Pollinations AI:
- [Pollinations Repository](https://github.com/pollinations/pollinations)
- [Pollinations Docs](https://pollinations.ai/)
## ✍️ About Developer
-->
Muskan Agarwal
