Skip to main content
Kunal Das

Code Connect - Real-Time Collaborative Development Platform

Browser-based collaborative development platform featuring real-time coding, shared terminals, live previews, GitHub integration, collaborative notes, and video communication.

Content type:Project
Duration:

Reading time:3 min read

Code Connect is a browser-based collaborative development platform that enables real-time coding, live previews, shared terminals, video communication, and collaborative note-taking.

๐ŸŒ Try now at codeconnect-dev.vercel.app

Features

  • Real-time Collaboration - Code together in real-time with cursor sharing, highlighting, and follow mode
  • Shared Terminal - Execute code and see results together with over 80 supported languages when a local Piston instance is configured
  • Live Preview - Preview UI changes instantly with loaded libraries like Tailwind CSS and more
  • GitHub Integrated - Save your work and open files from your repositories
  • Shared Notepad - Take notes together in real-time with rich text and markdown support
  • Video & Voice - Communicate with your team using video and voice chat

Project Structure

The project is organized into separate frontend and backend applications:

CodeConnect
โ”œโ”€โ”€ client/                  # Frontend Next.js application
โ”‚   โ”œโ”€โ”€ public/              # Static assets
โ”‚   โ””โ”€โ”€ src/                 # Source code
โ”‚       โ”œโ”€โ”€ app/             # Next.js app router pages and API routes
โ”‚       โ”œโ”€โ”€ components/      # React components
โ”‚       โ”œโ”€โ”€ hooks/            # Custom React hooks
โ”‚       โ””โ”€โ”€ lib/              # Utility functions and services
โ””โ”€โ”€ server/                  # Backend Socket.IO server
    โ””โ”€โ”€ src/                 # Source code
        โ”œโ”€โ”€ service/         # Backend services
        โ””โ”€โ”€ utils/           # Utility functions

Prerequisites

Before you begin, ensure you have the following installed:

Getting Started

After checking the prerequisites above, follow these steps to set up the project.

  1. Clone the repository

    git clone https://github.com/kunaldasx/code-connect.git
    cd code-connect
  2. Set up the frontend

    cd client
    npm install
    cp .env.example .env

    Configure the required environment variables in .env, then start the frontend:

    npm run dev
  3. Set up the backend

    Open a second terminal:

    cd server
    npm install
    cp .env.example .env
    npm run dev

Development

Once both applications are running, the development environment will be available at:

Optional: Enable Local Code Execution

Code execution is disabled in the hosted demo. To enable the shared terminal and code runner locally, run a self-hosted Piston instance.

git clone https://github.com/engineer-man/piston.git
cd piston
 
# Start the API
docker compose up -d api
 
# Install CLI dependencies
cd cli
npm install
 
# Install runtimes
node index.js ppman install python
node index.js ppman install node
node index.js ppman install typescript
node index.js ppman install java

Configure the client environment:

PISTON_API_URL=http://localhost:2000/api/v2/execute

Once configured, Code Connect can execute code through the local Piston instance.

Technologies

Contributing

Contributions are welcome. To contribute to Code Connect:

  1. Clone the repository and create a new branch:

    git checkout -b name_for_new_branch
  2. Make your changes and test them locally.

  3. Submit a Pull Request with a comprehensive description of your changes.

License

MIT


๐ŸŒ Visit my website โ†’
๐Ÿ–ฅ๏ธ GitHub ยท
๐Ÿ’ผ LinkedIn ยท
๐Ÿฆ Twitter / X