CodeHub - One Platform, Endless Collaboration!

CodeHub is a collaborative coding platform designed to cater to the diverse needs of developers, team leads, and project managers. It is dedicated to empowering individuals and teams to efficiently achieve their coding goals. Whether you're a developer seeking real-time collaboration or a team lead in need of robust project management tools, CodeHub is your one-stop solution.

This project has been done as a requirement for the CSN-254 course (Software Engineering) of IIT Roorkee.

📌 Table of Contents

• Features
• Tech Stack
• Flow Diagram
• Getting Started
• User Guide
• Future Scope
• Bug Reporting
• Support Us
• About Developers

🔮 Features

• 💻 Real-time collaboration on code editing across multiple files
• 🚀 Unique project generation with project ID & password for collaboration
• 🌈 Syntax highlighting for various file types with auto-language detection
• 💡 Auto suggestion based on programming language
• ⏱️ Instant updates and synchronization of code changes across all files
• 📣 Notifications for user join and leave events
• 🎨 Multiple themes for personalized coding experience
• 🌍 Comprehensive language support for versatile programming
• 🔠 Option to change font size and font family
• 👥 User presence list of users currently in the collaboration session, including online/offline status indicators
• 📁 Open, edit, save, and delete file functionalities
• 💾 Option to download files edited within the collaboration session
• 💬 Group chatting allows users to communicate in real-time while working on code.
• 🎩 Real-time tooltip displaying users currently editing
• 📋 Issue assigning for streamlined project management
• 👨🏼‍💻 User authentication through Sign-up and login functionality
• 🕵🏼‍♂️ Adding developers by admin.

💻 Tech Stack

🪢 Flow Diagram

📦 Getting Started

1. Fork this repository: Click the Fork button located in the top-right corner of this page to fork the repository.

2. Clone the repository:

   git clone https://github.com/<your-username>/CodeHub.git

3. Set .env file: Inside the client and server directory, create or edit the .env file and add the following line:
   Frontend:

   VITE_BACKEND_URL=<your_server_url>

   Backend:

   PORT=3000

4. Install dependencies: Navigate to the frontend and backend directories separately and run:

    npm install

5. Start the frontend and backend servers:
   Frontend:

   cd client
   npm run dev

   Backend:

   cd server
   npm run dev

6. Access the application: Open a browser and enter the following URL:

   http://localhost:5173/

📖 User Guide

Home Page

Login/Signup

Join/Create

Editor's Page

Chat/Users/Issue

🔮 Future Scope

• Compile Functionality: Implement an compile system to manage and access programming features.
• Search and Replace: Implement a search and replace functionality for efficient code navigation.

🐛 Bug Reporting

Feel free to open an issue on GitHub if you find bugs.

🌟 Support Us

If you find this helpful or valuable, please consider 🌟 starring the repository. It helps us gain visibility and encourages further development. We appreciate your support!

✍️ About Developers

Ansh Saini

Shaurya Jain

Vansh Saini

Nikunj Kansal

Varun Fadia