Codestream

A collaborative web based code-editor

View Demo · Report Bug · Request Feature

About The Project

Codestream is a collaborative web-based code editor. It allows one to collaborate with their teammates while writing code. Codestream uses codemirror as its code editor. It also provides syntax highlighting for many languages.

Design Doc

Codestream Case Study - Case Study

Built With

• React.js
• Chakra-UI
• CodeMirror
• Socket.io

Features

• Collaborative - Users can collaborate in real-time on their code
• Multiple Languages - Codestream supports multiple language highlighting
• Compiler - Codestream has an embedded compiler which can compile your code
• Chat - Users can chat while they collaborate
• Zen mode - Codestream supports zen mode for a better editing experience
• Responsive - Start collaborating through your mobile
• Question Pane - Add question directly in your room from supported websites(Leetcode, Codeforces, Atcoder, CSES)

Getting Started

Setup Codestream on your local machine using these simple steps:

Prerequisites

• npm

  npm install npm@latest -g

Installation

1. Fork the repo
2. Clone the repo

   git clone https://github.com/your_username_/codestream.git

3. Install NPM packages

   npm install

4. Create a .env file in the root directory. Enter your API in .env
   • If you have codestream-server already on your local system

     REACT_APP_SERVER = http://localhost:5000

   • If you have deployed the server on any platform replace http://localhost:5000 with the server URL.

Alternative

If you want to skip all this hassle and straight away dive into coding, consider creating a Codesandbox and import this repository using URL.

Roadmap

See the open issues for a full list of proposed features (and known issues).

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. 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

License

Distributed under the MIT License. See LICENSE.txt for more information.

Contact

Your Name - @7Aryany - [email protected]

Project Link: https://github.com/starwiz-7/codestream

Acknowledgments

• React Icons
• React-hot-toast