piyushn28/code-n-collab

CodeNCollab is a Collaborative Website for developers and competitive coders who likes to code and discuss about topics , problems or issues , etc

Table of Contents

1. About
   • Features
2. Getting Started
   • Prerequisites
   • Installation
3. Contributing
4. Contact
5. Resources
6. License

🔖 About

Code - N - Collab is a Collaboration website for Software developers , Competitive coders , and every one who loves to code and collaborate with others to learn and grow. It provides users to collaborate with their team , friends and also find people with similar their interests.

Website

Code-N-Collab

🚀 Features

It provides users with :-

• Real-time code editor : Users can collaborate with their team on issues and solve CP problems using a real-time code-editor(like Google Docs)

• Lockout Championship : For Cp lovers, they can compete in a lockout championships with their friends to and challenge your friends for championship,filter problems with preferred difficulty and improve you CP skills

• Blogs : To find new people and share your knowledge , platform provides users blogs to write learn and share

🔥 Getting Started

Prerequisites

• Reactjs
• Nodejs

Setup Environment variables

     REACT_APP_SIGNALLING_URL1 = wss://y-webrtc-signaling-eu.herokuapp.com
     REACT_APP_SIGNALLING_URL2 = wss://y-webrtc-signaling-us.herokuapp.com
     REACT_APP_BASE_URL = 'http://localhost:8080/'

Setup backend for Code - N - Collab

Code - N - Collab Backend

Installation

• Fork the Repository

   $ git clone https://github.com/<your-username>/Code-N-Collab.git
   $ cd Code-N-Collab
   $ git remote add upstream https://github.com/atharmohammad/Code-N-Collab.git
   $ npm install
   $ npm start

💁 Contribution guidelines

we encourage organizations and individuals to contribute requirements, documentation, issues, new templates, and code. For code contributions, read :

• The Code of Conduct
• The Contribution Guidelines
• The Documentation

📲 Contact

Mohd Athar - [email protected]
Adnan Shamsi - [email protected]

📚 Resources

• Socket.Io Documentation
• Yjs Docs
• React-Codemirror Editor Docs

📌 Credits :

This project exists, thanks to all the people who contribute.

License

Apache License 2.0