Skip to content

AshAman999/codeBuddy

Repository files navigation

CodeBuddy

image

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/ 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 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