sourabhrealtime/README.md

ROBUST RICH TEXT EDITOR: Single-pane contentEditable with direct text selection formatting, speech features, undo/redo, professional UI - Perfect TipTap alternative

# SourabhRealtime v2.3.1

A complete real-time collaboration platform with authentication, project management, approval workflows, and team collaboration features.

## 🚀 Features

- **🔐 Authentication System** - Complete login/signup with role-based access
- **📊 Project Management** - Create and manage collaborative projects  
- **✅ Approval Workflows** - Admin approval for changes and content
- **👥 Team Collaboration** - User invitations and permission management
- **⚡ Real-time Sync** - Instant cursor tracking and content synchronization
- **🎨 Modern UI** - Professional, responsive interface

## 📦 Installation

```bash
npm install sourabhrealtime@2.3.1
```

## 🔧 Quick Start

### Complete Platform

```jsx
import { CollaborationApp } from 'sourabhrealtime';
import 'sourabhrealtime/dist/enhanced-styles.css';

function App() {
  return (
    <CollaborationApp
      apiUrl="http://localhost:3002"
      requireApproval={true}
      showProjectManager={true}
    />
  );
}
```

### Simple Editor (Backward Compatible)

```jsx
import { RealtimeEditor } from 'sourabhrealtime';
import 'sourabhrealtime/dist/index.css';

function App() {
  return (
    <RealtimeEditor
      apiUrl="http://localhost:3002"
      projectId="project-123"
      userId="user-123"
      userName="John Doe"
      userRole="editor"
    />
  );
}
```

## 🛠️ Server Setup

Start the enhanced server (included in package):

```bash
# Download and start the server
node enhanced-server.js
```

## 🔐 Demo Credentials

- **Super Admin**: `superadmin@example.com` / `SuperAdmin123!`
- **Admin**: `admin@example.com` / `Admin123!`

## 📚 Components

### CollaborationApp
Complete collaboration platform with all features integrated.

### AuthProvider & useAuth
Authentication context and hook for user management.

### ProjectManager  
Project dashboard for creating and managing collaborative projects.

### RealtimeEditor
Enhanced real-time collaborative editor with cursor tracking.

### ApprovalWorkflow
Admin interface for approving content changes.

## 🔄 Migration from v2.1.7

✅ **Fully Backward Compatible** - All existing code continues to work.

## 📖 Documentation

For complete documentation, examples, and API reference, visit:
[GitHub Repository](https://github.com/yourusername/sourabhrealtime)

## 📄 License

MIT License

---

Built with ❤️ for real-time collaboration