🚀 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.
- 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.
Before you begin, ensure you have the following software installed on your system:
- Node.js (which includes npm)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
-
Clone the repository:
git clone https://github.com/your-username/stream-code.git cd stream-code
-
Install dependencies for both the frontend and backend: For the frontend:
# Copy code npm install
-
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.
- 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.
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.