/code2gether

Code2gether , a platform for developing web together

Primary LanguageJavaScriptMIT LicenseMIT

CODE2GETHER

Code2Gether is a Platform Designed for developing web components that you can code in HTML/CSS/JAVASCRIPT in collaboration with friends or collegues and see the result in real-time and even chat with each other while working on a project. All in One Platform !

Alt text Alt text

Requirements

Main Requirements used in this project are mentioned below:

  • Nodejs
  • Express
  • MongoDB
  • Socket.io
  • OTjs
  • PeerJs

Installation

  1. First make sure u have nodejs (and node package manager) and MongoDB installed on your system, if you don't you can get them from links below:
  • Nodejs

https://nodejs.org/en/download/

  • MongoDB

https://www.mongodb.com/try/download/community


  1. Clone or Download this Repository:
git clone https://github.com/mamathew98/code2gether.git

  1. Open a Terminal and head to root directory of the project and run npm install and wait for the dependecies to get installed:
cd /code2gether
npm install

  1. Make sure Your 3000 port on device is available and run:
npm start

  1. Open another Terminal and head to /PeerServer and run npm install and wait for dependecies to get installed
cd /PeerServer
npm install

  1. Make sure Your 9000 port on device is available and run npm start in /PeerServer directoy
npm start

  1. For Running on Your Local Server head to /public/javascripts/ and open editor.js File then Comment the section below //FOR SERVER DEPLOYMENT and Uncomment the section below // FOR LOCAL DEPLOYMENT

if you want to run application on a server you have to change the url provided in socket initiations in section below // FOR SERVER DEPLOYMENT


  1. Open a Browser and go to http://localhost:3000/

  1. Vola! Now you can register and make a project and share its link with others so you can collaborate on the project together

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

MIT