Home

Awesome

<!-- PROJECT SHIELDS -->

Contributors Forks Stargazers Issues MIT License LinkedIn All Contributors

<!-- PROJECT LOGO --> <br /> <p align="center"> <a href="https://caucus-app.herokuapp.com/"> <img src="images/logo.png" alt="Logo" width="256" height="256"> </a> <strong> <h3 align="center" >caucus</h3> </strong> <p align="center"> A Real Time Collaborative Editor with an embedded compiler <br /> <a href="https://github.com/Rishabh-malhotraa/caucus/tree/main/src"><strong>Explore the project ยป</strong></a> <br /> <br /> <a href="https://caucus-app.herokuapp.com/">View Demo</a> ยท <a href="https://github.com/Rishabh-malhotraa/caucus/issues">Report Bug</a> ยท <a href="https://github.com/Rishabh-malhotraa/caucus/issues">Request Feature</a> </p> </p> <!-- TABLE OF CONTENTS --> <details open="open"> <summary>Table of Contents</summary> <ol> <li> <a href="#about-the-project">About The Project</a> <ul> <li><a href="#built-with">Built With</a></li> </ul> </li> <li> <a href="#getting-started">Getting Started</a> <ul> <li><a href="#prerequisites">Prerequisites</a></li> <li><a href="#installation">Installation</a></li> </ul> </li> <li><a href="#roadmap">Roadmap</a></li> <li><a href="#contributing">Contributing</a></li> <li><a href="#license">License</a></li> <li><a href="#contact">Contact</a></li> <li><a href="#acknowledgements">Acknowledgements</a></li> </ol> </details>

๐Ÿ“ฃ 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

Product Demonstation

<br/>

Collaborative Code Editor

Product Name Screen Shot

Login PageNavigate Rooms Page
Product Name Screen ShotProduct Name Screen Shot
<br />

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.

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

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 - rishabhmalhotraa01@gmail.com

Discord : rishabh.malhotra#4193

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


Stargazers over time

Stargazers over time


Acknowledgements

<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->

Contributors โœจ

Thanks goes to these wonderful people (emoji key):

<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section --> <!-- prettier-ignore-start --> <!-- markdownlint-disable --> <table> <tr> <td align="center"><a href="https://rishabh-malhotraa.github.io/Rishabh-Portfolio-main/"><img src="https://avatars.githubusercontent.com/u/54576074?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Rishabh Malhotra</b></sub></a><br /><a href="#infra-Rishabh-malhotraa" title="Infrastructure (Hosting, Build-Tools, etc)">๐Ÿš‡</a> <a href="https://github.com/Rishabh-malhotraa/caucus/commits?author=Rishabh-malhotraa" title="Code">๐Ÿ’ป</a> <a href="#design-Rishabh-malhotraa" title="Design">๐ŸŽจ</a></td> <td align="center"><a href="https://github.com/MarufSharifi"><img src="https://avatars.githubusercontent.com/u/59383482?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Maruf</b></sub></a><br /><a href="#infra-MarufSharifi" title="Infrastructure (Hosting, Build-Tools, etc)">๐Ÿš‡</a> <a href="https://github.com/Rishabh-malhotraa/caucus/commits?author=MarufSharifi" title="Code">๐Ÿ’ป</a></td> <td align="center"><a href="https://github.com/swikars1"><img src="https://avatars.githubusercontent.com/u/20171676?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Swikar Sharma</b></sub></a><br /><a href="https://github.com/Rishabh-malhotraa/caucus/commits?author=swikars1" title="Documentation">๐Ÿ“–</a></td> <td align="center"><a href="https://www.linkedin.com/in/iamdevvalecha/"><img src="https://avatars.githubusercontent.com/u/71969867?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Dev Valecha</b></sub></a><br /><a href="#talk-iamdevvalecha" title="Talks">๐Ÿ“ข</a></td> <td align="center"><a href="https://github.com/HarrisonMayotte"><img src="https://avatars.githubusercontent.com/u/48367813?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Harrison Mayotte</b></sub></a><br /><a href="#infra-HarrisonMayotte" title="Infrastructure (Hosting, Build-Tools, etc)">๐Ÿš‡</a> <a href="https://github.com/Rishabh-malhotraa/caucus/pulls?q=is%3Apr+reviewed-by%3AHarrisonMayotte" title="Reviewed Pull Requests">๐Ÿ‘€</a></td> </tr> <tr> <td align="center"><a href="https://bit.ly/adityaarya1"><img src="https://avatars.githubusercontent.com/u/52771727?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Aditya Arya</b></sub></a><br /><a href="#design-Aditya9111" title="Design">๐ŸŽจ</a></td> <td align="center"><a href="https://github.com/mthakur7"><img src="https://avatars.githubusercontent.com/u/89182004?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Manju Thakur</b></sub></a><br /><a href="#design-mthakur7" title="Design">๐ŸŽจ</a></td> <td align="center"><a href="https://apexweb.me"><img src="https://avatars.githubusercontent.com/u/68195580?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Apex Web</b></sub></a><br /><a href="#design-chirag3003" title="Design">๐ŸŽจ</a></td> <td align="center"><a href="https://github.com/GaganpreetKaurKalsi"><img src="https://avatars.githubusercontent.com/u/54144759?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Gaganpreet Kaur Kalsi</b></sub></a><br /><a href="https://github.com/Rishabh-malhotraa/caucus/commits?author=GaganpreetKaurKalsi" title="Code">๐Ÿ’ป</a> <a href="#design-GaganpreetKaurKalsi" title="Design">๐ŸŽจ</a></td> <td align="center"><a href="https://pavankalyan-codes.github.io/"><img src="https://avatars.githubusercontent.com/u/35896290?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Pavan kalyan C</b></sub></a><br /><a href="https://github.com/Rishabh-malhotraa/caucus/commits?author=pavankalyan-codes" title="Code">๐Ÿ’ป</a></td> </tr> <tr> <td align="center"><a href="https://github.com/taksuparth"><img src="https://avatars.githubusercontent.com/u/13138123?v=4?s=140" width="140px;" alt=""/><br /><sub><b>Parth Bhavesh Shah</b></sub></a><br /><a href="https://github.com/Rishabh-malhotraa/caucus/commits?author=taksuparth" title="Code">๐Ÿ’ป</a></td> </tr> </table> <!-- markdownlint-restore --> <!-- prettier-ignore-end --> <!-- ALL-CONTRIBUTORS-LIST:END -->

This project follows the all-contributors specification. Contributions of any kind welcome!