Giter VIP home page Giter VIP logo

caucus-server's Introduction

📣 Announcements

🆕 02-03-2022: Moving the contents of this repository to caucus, for better Developer experience and making it easier to setup the project. This repo would be archived.


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


Collaboratice 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-server.git
  2. Install NPM packages

    npm install
  3. Start the react server

    npm run dev
  4. Add Enviroment Variables

     GITHUB_KEY_CLIENTID = get your key from  https://github.com/settings/applications
     GITHUB_KEY_CLIENTSECRET= https://github.com/settings/applications
     GOOGLE_KEY_CLIENTID= https://console.cloud.google.com/apis/credentials
     GOOGLE_KEY_CLIENTSECRET= https://console.cloud.google.com/apis/credentials
     TWITTER_KEY_CONSUMERKEY = https://developer.twitter.com/en/portal/projects
     TWITTER_KEY_CONSUMERSECRET =https://developer.twitter.com/en/portal/projects
     JDOODLE_CLIENTID=https://www.jdoodle.com/
     JDOOLDE_CLIENTSECRET= https://www.jdoodle.com/
     COOKIE_KEYS= your-cookie-secrert
     PROD= false
     DATABASE_URL = postgresql://postgres:password@localhost:5432/rtce
     CLIENT_URL = http://localhost:3000
     JDOODLE_URL = https://api.jdoodle.com/v1/execute
     SERVER_URL = http://localhost:5000
    

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: https://caucus-app.herokuapp.com/


Acknowledgements

caucus-server's People

Contributors

rishabh-malhotraa avatar imgbot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.