DocScribe

A real-time collaborative document editor inspired by Google Docs.

Features

• JWT Authentication (secure login/register)
• Role-based Access Control (owner, editor, viewer)
• Real-time Collaboration (Socket.IO, Quill)
• Live Cursor Indicators
• Comment System (real-time, collaborative)
• Version History (view/restore previous versions)
• Document Sharing (invite users, assign roles)
• Modern UI (Material-UI, responsive, dialogs)

Tech Stack

• Frontend: React, Material-UI, Quill, Socket.IO Client
• Backend: Node.js, Express, Socket.IO, MongoDB, Mongoose, JWT

Getting Started

Prerequisites

• Node.js (v16+ recommended)
• npm
• MongoDB (local or Atlas)

Installation

1. Clone the repo:

   git clone https://github.com/utpal-kumar-08/docScribe.git
   cd docScribe

2. Install server dependencies:

   cd server
   npm install

3. Install client dependencies:

   cd ../client
   npm install

Environment Variables

Create a .env file in the server directory:

PORT=5001
JWT_SECRET=your_jwt_secret_here
MONGO_URI=mongodb://localhost:27017/docscribe

Running the App

1. Start MongoDB (if local):
   • On Windows: Run "MongoDB Compass" or mongod in a terminal
2. Start the backend:

   cd server
   npm start

3. Start the frontend:

   cd ../client
   npm start

4. Open http://localhost:3000 in your browser

Usage

• Register and log in
• Create, edit, and share documents
• Collaborate in real-time with others
• Add comments, view version history, and restore previous versions

License

MIT