aarize29 / cowrite

A collaborative text editor build using socket.io and react.

CoWrite

Collaborate in real-time with others on a shared document using this collaborative text editor. Effortlessly work together on written projects, from anywhere, anytime.

Features

1. Room joining notification.
2. Live text sync
3. Responsive design
4. Get participants list.

Screenshots

Desktop version:

Smartphone view:

HomePage:

Tech Stack : MERN

Technology and Packages used:

Front end:

• React.js - A component based js library to build UI.
• Toast - for notifications
• React Router - For creating internal routes ( obviously)
• React hooks - State management , navigation and orchestration.

Backend:

• Node.js - Js runtime
• Express - A node js frame work to make writing js in node easy.
• Socket.io - Bidirectional and low-latency communication for every platform

Hosting:

• Railway

Installation

Install CoWrite with npm

  git clone 'git remote add origin https://github.com/PriyanshShrivastava/CoWrite.git'
  cd CoWrite
  npm install
  npm run dev  (assuming you have vite already installed)

To build for production

npm run build 

To previw the build

npm run preview 

Documentation

Vite Documentation

React Documentation

Socket IO

Authors

• Priyansh Shrivastava