Skip to content

Latest commit

 

History

History
93 lines (54 loc) · 2.89 KB

README.md

File metadata and controls

93 lines (54 loc) · 2.89 KB

Real-Time Code Editor

This project is a real-time code editor built using React, Socket.io, and CSS. It allows multiple users to collaborate in real-time on code editing tasks. Users can see each other's changes in real-time and communicate through a chat feature.

Technologies Used

  • React: The front-end of the application is built using React, a popular JavaScript library for building user interfaces. React provides a fast and efficient way to create dynamic web applications.

  • Socket.io: Socket.io is used for real-time communication between clients and the server. It enables real-time collaboration by allowing clients to send and receive messages instantly.

  • CSS: Cascading Style Sheets (CSS) are used for styling the user interface, making the code editor visually appealing and user-friendly.

Features

  • Real-Time Collaboration: Users can collaborate on code editing tasks in real-time. Any changes made by one user are immediately visible to others.

  • Syntax Highlighting: The code editor includes syntax highlighting for various programming languages, making it easier for users to write and understand code.

Installation

  1. Clone the repository to your local machine:

    git clone https://github.com/JavedHussain-06/realtime-code-editor

  2. Navigate to the project directory:

    cd real-time-code-editor

  3. Install the dependencies:

    npm install

  4. Start the development server:

    npm start

  5. Open a new terminal window, navigate to the project directory, and run the app:

    npm run dev:front

  6. Open your web browser and access the application at http://127.0.0.1:5000/.

Usage

  1. Open the application in your web browser.

  2. Start a new code editing session or join an existing one.

  3. Collaborate with others in real-time, write code, and use the chat feature to communicate.

  4. Save your code as needed.

Contributing

If you'd like to contribute to this project, please follow these guidelines:

  1. Fork the repository on GitHub.

  2. Create a new branch for your feature or bug fix:

    git checkout -b feature/your-feature-name

  3. Make your changes and commit them with clear, concise commit messages.

  4. Push your changes to your fork:

    git push origin feature/your-feature-name

  5. Create a pull request on the original repository explaining your changes and their purpose.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Contact

If you have any questions or suggestions, feel free to contact us at [email protected] or open an issue on GitHub. We welcome your feedback and contributions.

Happy coding!