Coxing code: collaborative coding

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

• Docker (25.0.4)
• Docker Compose (1.29.2)

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 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

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

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