Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Rishabh-malhotraa/caucus

Realtime Collaborate Editor with Embedded Compiler
https://github.com/Rishabh-malhotraa/caucus

codeforces codemirror hacktoberfest leetcode opensource react realtime-collaboration remote-code-execution yjs

Last synced: 5 days ago
JSON representation

Realtime Collaborate Editor with Embedded Compiler

Host: GitHub
URL: https://github.com/Rishabh-malhotraa/caucus
Owner: Rishabh-malhotraa
License: mit
Created: 2021-02-25T07:59:52.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-05-01T07:29:07.000Z (7 months ago)
Last Synced: 2024-08-02T17:38:33.117Z (3 months ago)
Topics: codeforces, codemirror, hacktoberfest, leetcode, opensource, react, realtime-collaboration, remote-code-execution, yjs
Language: TypeScript
Homepage: https://caucus.rishabhmalhotra.in/
Size: 5.28 MB
Stars: 296
Watchers: 3
Forks: 69
Open Issues: 28
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

        

[![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

[![MIT License][license-shield]][license-url]

[![LinkedIn][linkedin-shield]][linkedin-url]

[![All Contributors][all-contributors-shield]](#contributors-)






  

    

  

  

    
caucus


  

  


    A Real Time Collaborative Editor with an embedded compiler

    


    Explore the project »

    


    


    View Demo

    ·

    Report Bug

    ·

    Request Feature

  


  Table of Contents

  


    

      About The Project

      

        Built With

      

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Roadmap

    Contributing

    License

    Contact

    Acknowledgements

  


## 📣 Latest Announcements

🆕 5-10-2021: We now have a discussions form, if you want any new feature to be implemented you can [discuss here](https://github.com/Rishabh-malhotraa/caucus/discussions/50)

🆕 28-09-2021: Caucus is participating in Hacktoberfest 2021 🥳

## About The Project

### Demonstration

[![Product Demonstation][product-demo]](https://caucus-app.herokuapp.com/)




### Collaborative Code Editor

[![Product Name Screen Shot][product-screenshoti]](https://caucus-app.herokuapp.com/)

|                                       Login Page                                       |                                   Navigate Rooms Page                                   |

| :------------------------------------------------------------------------------------: |    :-------------------------------------------------------------------------------------: |

| [![Product Name Screen Shot][product-screenshotii]](https://caucus-app.herokuapp.com/) | [![Product Name Screen Shot][product-screenshotiii]](https://caucus-app.herokuapp.com/) |




### Built With

- [React](https://reactjs.org/docs/getting-started.html)

- [Material UI](https://material-ui.com/getting-started/installation/)

- [yjs](https://yjs.dev/)

Written in TypeScript ♥

## Getting Started

Follow the instructions to set up the project on your local machine.

### Prerequisites

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

- npm

  ```sh

  npm install npm@latest -g

  ```

### Installation

1. Fork the repo(required), a star is also appretiated but optional :P

2. Clone the forked repo

   ```sh

   git clone https://github.com/{your-github-username}/caucus.git

   ```

   example : `git clone https://github.com/Rishabh-malhotraa/caucus.git`

3. Install NPM packages

   ```sh

   npm run install-modules

   ```

4. Start the react and nodejs server concucrrently

   ```sh

   npm run dev

   ```

### Setting up DATABASE

To setup the database with mockdata, follow this [guide](/Setting%20up%20Database.md)

### Execute Code

To allow cuacus to execute code, you need to get your api keys from [JDoodle](https://www.jdoodle.com/) and add them to the `.env` file

Update: I have included API keys from a dummy account, you can get your own also from JDoodle, the keys are restricited to 200 executions per day, and is visible to everyone, you can get your own private key at JDOODLE

``` text

JDOODLE_CLIENTID=get_your_key

JDOOLDE_CLIENTSECRET=get_your_key

```

## Roadmap

See the [open issues](https://github.com/Rishabh-malhotraa/caucus/issues) for a list of proposed features (and known issues).

### Things To do

- [x] Inital Login Page

- [x] Database hookup with login from oAuth

- [x] Chat Application

- [x] Video Chat Application (the main chunk of work)

- [x] Collaborative Editing (the main chunk of work)

- [x] Resizable Panes

- [x] Code Running (Easy need to just hookup with an api)

- [x] Database with all the leetcode question and sorted based on tags.

- [x] IMP: Sync code using localstorage or sockets when a new person joins in the room, with defaultvalue prop on the monaco editor instance.

- [x] Add SSL certificate to the docker container, andd get rid of the current bootleg shenanigans D: (LetsEncrypt or Cloudflare)

- [x] Add codeforce problem using webscraping thingy

- [x] Add Vim Keybinds

- [x] Add intellisense using Language Server Protocal for atleast C++ and JAVA

- [x] Make a public api to fetch questions, based on scraped data

- [ ] Add a full-screen Zen Mode

- [ ] Change Hosting from Heroku to GCP or Digital Ocean

- [ ] Change Heroku PSQL DB to either ~~MongoDB or Firebase~~ SQLITE.

- [ ] Add Autoformating keybind.

- [ ] ~~Fix the number of users in the room.~~

- [ ] ~~REACH: Add video call functionality (using WEBRTC or something propieteary like Twilo proprietary)~~

- [ ] ~~Add ability to add different tabs on the editor instance just like that on VSCODE~~

- [ ] ~~Integrate the random quote thingy on loading screen from forticodes API~~

- [ ] ~~Fix why the loader gets frozen on intial render -\_-~~

## 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**.

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

Refer to this [article](https://medium.com/swlh/guide-to-git-a-practical-approach-27926a1ff564?sk=b54ca413a142c275f5d2901d0384a0db) if you have any difficulty in making a pull request

## License

Distributed under the MIT License. See [`LICENSE`][license-url] for more information.

---

## Contact

Rishabh malhotraa - [@rish_bishhh](https://twitter.com/rish_bishhh) - [email protected]

Discord : rishabh.malhotra#4193

Project Link: [https://caucus-app.herokuapp.com/](https://caucus-app.herokuapp.com/)

---

## Stargazers over time

[![Stargazers over time](https://starchart.cc/rishabh-malhotraa/caucus.svg)](https://starchart.cc/rishabh-malhotraa/caucus)

---

## Acknowledgements

- [Heroku](https://www.heroku.com/)

- [Azure](https://azure.microsoft.com/en-us/)

- [notistack](https://www.npmjs.com/package/notistack/)

- [axios](https://www.npmjs.com/package/axios)

- [dog-names](https://www.npmjs.com/package/dog-names)

- [Best-README-Template](https://github.com/othneildrew/Best-README-Template)

- [MIT License](https://opensource.org/licenses/MIT)

- [SVG Backgrounds](https://www.svgbackgrounds.com/)

[all-contributors-shield]: https://img.shields.io/badge/all_contributors-8-orange.svg?style=for-the-badge

[contributors-shield]: https://img.shields.io/github/contributors/Rishabh-malhotraa/caucus.svg?style=for-the-badge

[contributors-url]: https://github.com/Rishabh-malhotraa/caucus/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/Rishabh-malhotraa/caucus.svg?style=for-the-badge

[forks-url]: https://github.com/Rishabh-malhotraa/caucus/network/members

[stars-shield]: https://img.shields.io/github/stars/Rishabh-malhotraa/caucus.svg?style=for-the-badge

[stars-url]: https://github.com/Rishabh-malhotraa/caucus/stargazers

[issues-shield]: https://img.shields.io/github/issues/Rishabh-malhotraa/caucus.svg?style=for-the-badge

[issues-url]: https://github.com/Rishabh-malhotraa/caucus/issues

[license-shield]: https://img.shields.io/github/license/Rishabh-malhotraa/caucus.svg?style=for-the-badge

[license-url]: https://github.com/Rishabh-malhotraa/caucus/blob/main/LICENSE.txt

[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555

[linkedin-url]: https://www.linkedin.com/in/rishabh-malhotra-4536a418b

[product-demo]: images/caucus-demonstation.gif

[product-screenshoti]: images/code-editor.png

[product-screenshotii]: images/login-page.png

[product-screenshotiii]: images/navigation-page.png

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

  

    
_{Rishabh Malhotra}
🚇 💻 🎨

    
_Maruf
🚇 💻

    
_{Swikar Sharma}
📖

    
_{Dev Valecha}
📢

    
_{Harrison Mayotte}
🚇 👀

  

  

    
_{Aditya Arya}
🎨

    
_{Manju Thakur}
🎨

    
_{Apex Web}
🎨

    
_{Gaganpreet Kaur Kalsi}
💻 🎨

    
_{Pavan kalyan C}
💻

  

  

    
_{Parth Bhavesh Shah}
💻

  

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!