Skip to content

Guedd/caucus

 
 

Repository files navigation

Contributors Forks Stargazers Issues MIT License LinkedIn


Logo

caucus

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

View Demo · Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started
  3. Roadmap
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgements

About The Project


Collaborative Code Editor

Product Name Screen Shot

Login Page Navigate Rooms Page
Product Name Screen Shot Product Name Screen Shot

Built With

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

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.

Contributing

Contributions are what make the open source community such an amazing place to be 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 - @CaffeinatedRish - [email protected]

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


Acknowledgements

About

Realtime Collaborate Editor with Embeded Compiler

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 89.3%
  • JavaScript 8.7%
  • HTML 2.0%