https://github.com/mdmassum/codetogether

A virtual codespace for multiple coders to code simultaneously. Simultaneous work environment.
https://github.com/mdmassum/codetogether

codemirror docker express mongodb nodejs reactjs redis socket-io

Last synced: 21 days ago
JSON representation

A virtual codespace for multiple coders to code simultaneously. Simultaneous work environment.

• Host: GitHub
• URL: https://github.com/mdmassum/codetogether
• Owner: MdMassum
• Created: 2024-12-17T07:54:35.000Z (about 1 month ago)
• Default Branch: master
• Last Pushed: 2025-01-03T09:10:46.000Z (27 days ago)
• Last Synced: 2025-01-03T10:23:47.341Z (27 days ago)
• Topics: codemirror, docker, express, mongodb, nodejs, reactjs, redis, socket-io
• Language: JavaScript
• Homepage: https://code-together-ashy.vercel.app
• Size: 342 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Code Together: Realtime Collaborative Code Editor

## Introduction

Are you tired of sending code snippets back and forth, struggling to debug and collaborate with your team? Look no further! **Code Together** is here to revolutionize the way you code together. This powerful and intuitive collaborative code editor is designed to empower developers, and teams to work seamlessly in real-time, regardless of their location. With **Code Together**, you can code together, debug together, and ship faster, together.

## Features

- Multiple users can join a room and edit code together

- Changes are reflected in real time

- Copy button to copy the room id to clipboard

- Leave button to leave the room

- Supports syntax highlighting for different programming languages

- Users can choose theme based on their preferences

- Users can leave the room and rejoin later to continue editing

- Joining & leaving of users is also reflected in real time

### Prerequisites

#### For running via Docker

- Docker (25.0.4)

- Docker Compose (1.29.2)

#### For running locally

- Node.js (v20.11.1)

- npm (10.2.4)

- pm2 (5.3.1) : run `npm i -g pm2` to install pm2 globally

**Note:** I have used nvm (v0.39.7) to manage my node versions. View nvm official [documentation](https://github.com/nvm-sh/nvm) to install it.

## Tech Stack

- React.js

- Node.js

- Express.js

- Socket.io

- CodeMirror

- React-Toastify

## Installation

### Running via building your own Docker Image

To run the app using docker, follow the steps below:

1. Install [Docker](https://www.docker.com/) on your machine.

2. Clone the project repository and Navigate to the project directory.

3. Also you have to change ENV values in the Dockerfile

4. Replace your username in docker-compose.yml file.

5. Run the Docker Compose command: `docker-compose up -d`

6. Go to `http://localhost:3000` to view the app

7. Follow the steps 5-7 from the [Running via Docker Image]() section to create and join a room

### DEMO

..

### Running Locally

1. Clone this repository and cd into it

2. Run `npm install` to install the dependencies

3. Create .env file in the root folder and copy paste the content of example.env, and add necessary credentials.

4. To start the react app client run `npm start` in one terminal

5. To start the server run `npm server:dev` or `pm2 start server.js` in another terminal

6. Go to `http://localhost:3000` to view the app

7. Follow the steps 4-7 from the [Running via Docker Image]() section to create and join a room

**Note:** To stop your server, press `Ctrl+c` or if you used "pm2", then use `pm2 stop server.js` in the terminal.