Code Xerox

A collaborative code editor with live code sharing and video calling. Try out with this given Project link.

Table of Contents

1. About The Project
   • Features of this project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. Contact
6. Vote of thanks

About The Project

When a text editor is outfitted with collaborative editing capabilities, and real time conversation it can be a show stopper. There are a number of applications available that excel at offering such functionality. I wanted to design and build a system that could handle simple text editing along with communication and collaboration. Using the Code Xerox, several users may collaborate on documents in real time. The current editing stances of other users are always visible via Remote-Cursors.

Main feature of the code xerox are as follows

• Multiple users can edit code in real time. 💞
• You can communicate in real time via video andd audio call ☎️
• Syntax highlighting is present currently supporting C-like languages. 😄
• You can create as many rooms as you want [but currently have a scalibility issues] 🤗
• You can also chat in chat window 💬

(back to top)

Built With

Major frameworks/libraries used to bootstrap your project.

1. HTML
2. CSS
3. JavaScript
4. NodeJs
5. Expressjs
6. Socket.io
7. Peerjs
8. Uuid
9. Code mirror

(back to top)

Getting Started

Follow thses steps to run the code on your local host. To get a local copy up and running follow these simple example steps.

Prerequisites

This is an example of how to list things you need to use the software and how to install them.

• npm

  npm install npm@latest -g

Installation

1. Clone the repo

   gh repo clone BornPsych/code-xerox-v1

2. Install NPM packages

   npm install

3. Open the terminal in the root folder and run the command

   npm run dev

Open in the http://localhost:3000 to open the instance of the app and copy the link in the other tab and see the magic.

(back to top)

Usage

You can also use the given hosted link to talk with your friend [ If it does not work try multiple time because it has scalibility and ping issues. I promise it will work 🤞 ]

(back to top)

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

Contact

Yogesh Shahi - LinkedIn - Yogesh Shahi - [email protected]

(back to top)

Vote of Thanks

• Thanks to Rajat Agarwal for Equally contributing to the code and completing the project.