Rishabh-malhotraa / caucus

Realtime Collaborate Editor with Embedded Compiler

caucus

A Real Time Collaborative Editor with an embedded compiler
Explore the project »

View Demo · Report Bug · Request Feature

Table of Contents

1. About The Project
   • Built With
2. Getting Started
   • Prerequisites
   • Installation
3. Roadmap
4. Contributing
5. License
6. Contact
7. 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

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

About The Project

Demonstration

Collaborative Code Editor

Login Page	Navigate Rooms Page

Built With

• React
• Material UI
• yjs

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

  npm install npm@latest -g

Installation

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

2. Clone the forked repo

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

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

3. Install NPM packages

   npm run install-modules

4. Start the react and nodejs server concucrrently

   npm run dev

Setting up DATABASE

To setup the database with mockdata, follow this guide

Execute Code

To allow cuacus to execute code, you need to get your api keys from JDoodle 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

JDOODLE_CLIENTID=get_your_key
JDOOLDE_CLIENTSECRET=get_your_key

Roadmap

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

Things To do

• Inital Login Page
• Database hookup with login from oAuth
• Chat Application
• Video Chat Application (the main chunk of work)
• Collaborative Editing (the main chunk of work)
• Resizable Panes
• Code Running (Easy need to just hookup with an api)
• Database with all the leetcode question and sorted based on tags.
• IMP: Sync code using localstorage or sockets when a new person joins in the room, with defaultvalue prop on the monaco editor instance.
• Add SSL certificate to the docker container, andd get rid of the current bootleg shenanigans D: (LetsEncrypt or Cloudflare)
• Add codeforce problem using webscraping thingy
• Add Vim Keybinds
• Add intellisense using Language Server Protocal for atleast C++ and JAVA
• 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 if you have any difficulty in making a pull request

License

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

---

Contact

Rishabh malhotraa - @rish_bishhh - [e-mail]

Discord : rishabh.malhotra#4193

Project Link: https://caucus-app.herokuapp.com/

---

Stargazers over time

---

Acknowledgements

• Heroku
• Azure
• notistack
• axios
• dog-names
• Best-README-Template
• MIT License
• SVG Backgrounds

Contributors ✨

Thanks goes to these wonderful people (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 specification. Contributions of any kind welcome!