https://github.com/ashaman999/codebuddy

A simple collaborative code editor
https://github.com/ashaman999/codebuddy

code-editor express hacktoberfest javascript reactjs socket-io

Last synced: about 2 months ago
JSON representation

A simple collaborative code editor

• Host: GitHub
• URL: https://github.com/ashaman999/codebuddy
• Owner: AshAman999
• License: mit
• Created: 2022-10-25T10:49:41.000Z (about 2 years ago)
• Default Branch: master
• Last Pushed: 2023-10-22T10:19:23.000Z (about 1 year ago)
• Last Synced: 2024-04-28T04:54:43.808Z (9 months ago)
• Topics: code-editor, express, hacktoberfest, javascript, reactjs, socket-io
• Language: JavaScript
• Homepage: https://codebuddytextedit.netlify.app/
• Size: 1000 KB
• Stars: 5
• Watchers: 1
• Forks: 1
• Open Issues: 9
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CodeBuddy

![image](https://github.com/AshAman999/codeBuddy/actions/workflows/node.js.yml/badge.svg)





Try it out here 👇

https://codebuddytextedit.netlify.app/

## Basics

- A simple minimalist collabrative code editor

- This Web app is made keeping in mind for low bandwidth networks

- Let's users connect and write code in collaboration

## Build & Run

### React App

- Fork Repo: `git clone https://github.com/AshAman999/codeBuddy`

- Install Dependencies `yarn install`

- Start the React Project `yarn start`


### Server

- Start Server `cd server`

- Install Dependencies `npm i`

- Start relay Server `node server.js`

- visit [http://localhost:3000/](http://localhost:3000/) to see the running application

## Tech Stacks Used

| Needs                  | Tech Used                           |

| ---------------------- | ----------------------------------- |

| UI Library             | React                               |

| State Management       | Default Hooks                       |

| Web Sockets            | WebSocket client for react and Node |

| Speciality             | Low Network Usage , Lightweight     |

| Backend (Relay Server) | Node.js                             |

| Testing Library        | Jest                                |

## Features

- Need to create or join room to get started

- See all the users on the home screen

- Ability to write code in collabration

- Run code locally on the browsr itself to see the results (javascript only)

- Low network Usablity



  _More features coming soon_

## Screenshots








## Contributing

Before contributing, please read the [common contributors guide](https://opensource.guide/) for useful information.

## Extras

Thanks for your read into this project's readme, would really appreciate the contributions and even reporting of bugs is highly appreciated.

- If you have any ideas do raise an issue for that.

- If you feel like you can help me with code, have a look at the issues section