piyushkhurana / caucus Goto Github PK

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

View Demo · Report Bug · Request Feature

Login Page	Navigate Rooms Page

• React
• Material UI
• ConvergenceLabs

Written in TypeScript ♥

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

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

1. Clone the repo

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

2. Install NPM packages

   npm install

3. Start the react server

   npm run start

4. Add Enviroment Variables

   REACT_APP_CLIENT_URL = https://localhost:3000
   REACT_APP_SERVER_URL = https://localhost:5000
   REACT_APP_CONVERGENCE_URL = https://localhost:8080 
   

5. Download Docker Desktop and then download convergence omnibus from docker hub and then start the server

   docker pull convergencelabs/convergence-omnibus

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

• 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.

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

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

Rishabh malhotraa - @CaffeinatedRish - [email protected]

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

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