Skip to content

Latest commit

 

History

History
58 lines (41 loc) · 2.37 KB

README.md

File metadata and controls

58 lines (41 loc) · 2.37 KB
Raw

Stream Code

🚀 Welcome to the official GitHub repository of Stream Code, a cutting-edge, real-time collaborative code editor built using React, Node.js, Express, and Socket.io. Stream Code allows multiple users to interact and edit code simultaneously in a seamless and efficient manner.

Features

  • Real-Time Collaboration: Synchronize code edits live with other users, enhancing teamwork and productivity.
  • Room Management: Users can create, join, and leave rooms to organize collaboration sessions effectively.
  • Upcoming Feature - Code Execution: We are excited about our upcoming feature that will enable users to run their code directly within the app, supporting a variety of programming languages and complex environments.

Demo

🔗 https://www.linkedin.com/posts/anurag-dalsaniya-48a48b254_coding-softwaredevelopment-collaboration-activity-7189518251914158083-WqUR?utm_source=share&utm_medium=member_android

Prerequisites

Before you begin, ensure you have the following software installed on your system:

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Installation

  1. Clone the repository:

    git clone https://github.com/your-username/stream-code.git
cd stream-code

  2. Install dependencies for both the frontend and backend: For the frontend:

    # Copy code
npm install

  3. Running the Application

    Start the Frontend:

    # Make sure you are in the frontend directory
npm start

This command starts the React application in development mode. Open http://localhost:3000 to view it in the browser.

  1. Start the Backend: 
    # Make sure you are in the frontend directory
npm run server:dev

This will launch the Node.js/Express server on http://localhost:3001 (or your configured port), which handles real-time communication via Socket.io.

Contributing

Contributions to Stream Code are welcome and greatly appreciated. Here are the steps to contribute:

Fork the repository.
Create your feature branch (git checkout -b feature/AmazingFeature).
Commit your changes (git commit -m 'Add some AmazingFeature').
Push to the branch (git push origin feature/AmazingFeature).
Create a new Pull Request.