Code Xerox
A collaborative code editor with live code sharing and video calling. Try out with this given Project link.
Table of Contents
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 and 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 π¬
Built With
Major frameworks/libraries used to bootstrap your project.
- HTML
- CSS
- JavaScript
- NodeJs
- Expressjs
- Socket.io
- Peerjs
- Uuid
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
- Clone the repo
gh repo clone rajatagarwal768/Code-Xerox
- Install NPM packages
npm install
- Open the terminal in the root folder and run the command
npm run dev
http://localhost:3000 to open the instance of the app and copy the link in the other tab and see the magic.
Open in theUsage
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 π€ ]
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!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Contact
Rajat Agarwal - LinkedIn - Rajat Agarwal - rajatagarwal768@gmail.com
Vote of Thanks
- Thanks to Yogesh Shahi for Equally contributing to the code and completing the project.