<br /> <div align="center"> <a href="https://github.com/othneildrew/Best-README-Template"> <img src="https://res.cloudinary.com/hackbot/image/upload/v1634825298/Codestream/default-monochrome-black_zrplwm.png" alt="Logo" width="400" height="80"> </a> <h3 align="center">Codestream</h3> <p align="center"> A collaborative web based code-editor </p> <p align="center"> <a href="https://codestream.vercel.app">View Demo</a> · <a href="https://github.com/starwiz-7/codestream/issues">Report Bug</a> · <a href="https://github.com/starwiz-7/codestream/issues">Request Feature</a> </p> </div>

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. <br/> <br/> <br/> <img src="https://res.cloudinary.com/hackbot/image/upload/v1634828588/Codestream/code-dark_z4lw7c.png" alt="Editor"> </img>

Design Doc

Codestream Case Study - <a href="https://starwiz.notion.site/starwiz/Codestream-1d901b06f80d44a785933db23d0b60a9">Case Study</a>

Built With

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

Fork the repo

Clone the repo

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

Install NPM packages
```
npm install
```
Create a .env file in the root directory. Enter your API in .env
- If you have <a href="https://github.com/starwiz-7/codestream-server">codestream-server</a> 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 <a href="https://codesandbox.io/">Codesandbox</a> 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!

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

License

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

Contact

Your Name - @7Aryany - aryan2019@iiitkottayam.ac.in

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

Acknowledgments

Codestream

Install / Use

README