https://github.com/nitor-infotech-oss/realtime-collaborative-document-editing-app
This app leverages React.js on the frontend and Nest.js, on the backend along with WebSockets Gateway to provide a seamless real-time collaborative document editing experience. Users can collaborate simultaneously on documents, seeing changes instantly with robust real-time synchronization.
https://github.com/nitor-infotech-oss/realtime-collaborative-document-editing-app
mongoose nestjs-backend nestjs-microservices nestjs-mongoose react-hooks reactjs tailwind-css websocket-api websockets
Last synced: 7 months ago
JSON representation
This app leverages React.js on the frontend and Nest.js, on the backend along with WebSockets Gateway to provide a seamless real-time collaborative document editing experience. Users can collaborate simultaneously on documents, seeing changes instantly with robust real-time synchronization.
- Host: GitHub
- URL: https://github.com/nitor-infotech-oss/realtime-collaborative-document-editing-app
- Owner: nitor-infotech-oss
- Created: 2024-07-17T11:27:14.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-07-28T19:13:40.000Z (about 1 year ago)
- Last Synced: 2025-02-01T09:22:11.228Z (9 months ago)
- Topics: mongoose, nestjs-backend, nestjs-microservices, nestjs-mongoose, react-hooks, reactjs, tailwind-css, websocket-api, websockets
- Language: TypeScript
- Homepage:
- Size: 337 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Author - Pooja Tikhe (S/W Engineer at Nitor Infotech)
INTRODUCTION -
--------------------------------------------------------------------------------------------------------
In today's interconnected world, seamless collaboration on documents among multiple users is
essential for productivity and efficiency. The Real-Time Collaborative Document Editor is a
cutting-edge application designed to facilitate simultaneous editing of shared documents by
multiple users in real time. This project harnesses the power of modern web technologies,
including NestJS for the backend, WebSocket for real-time communication, and robust
authentication mechanisms to ensure data security and user privacy
KEY-FEATURES ->
--------------------------------------------------------------------------------------------------------
1. Real-Time Collaboration
2. Document & users management
3. Identification/mapping of websocket client with database user
4. Authentication & Authorization
5. Conflict Resolution
6. Persistence
7. Maintaining DTO’s (Data Transfer Object)
8. Class-Validator & Class-Transformer
TECHNOLOGY STACK ->
--------------------------------------------------------------------------------------------------------
1. Frontend : ReactJS, state management(ContextAPI), TailwindCSS
2. Backend : NestJS, WebSockets Gateway, Socket.io-client, Mongoose, Mongo-Atlas, JWT(JSON web token - HMAC with SHA-256), Typescript
PROJECT STRUCTURE ->
--------------------------------------------------------------------------------------------------------
Realtime-collaborative-doc-editor/
│
├── src/
│ ├── app.module.ts // Main module
│ ├── document/ // Document module
│ │ ├── document.controller.ts // Document controller
│ │ ├── document.service.ts // Document service
│ │ ├── document.entity.ts // Document entity (Mongoose)
│ │ └── document.module.ts // Document module definition
│ │
│ ├── auth/ // Authentication module
│ │ ├── auth.controller.ts // Auth controller (login, register)
│ │ ├── auth.service.ts // Auth service (JWT authentication)
│ │ └── auth.module.ts // Auth module definition
│ │ └── jwt.strategy.ts
│ │ └── guards
│ │ ├── jwt-guards.auth.ts // JWT guard for authentication
│ │
│ ├── user/ // User module
│ │ ├── user.controller.ts // User controller
│ │ ├── user.service.ts // User service
│ │ ├── user.entity.ts // User entity (Mongoose)
│ │ └── user.module.ts // User module definition
│ ├── socket.gateway.ts // WebSocket gateway
│ │
│ └── main.ts // Entry point for the application
├── .env // Environment variables
└── package.json // Project dependencies and scripts
VIDEO-DEMO URL ->
--------------------------------------------------------------------------------------------------------
1. Frontend :
Part 1 - https://www.loom.com/share/ef97f7ba1e16435baf3506f7e2333ab8?sid=9ab4cb8c-39a9-48ea-9cde-c55c023b6e76
Part 2 - https://www.loom.com/share/db0d9a09a1a64a1196e2fb717db1fea2?sid=82fe327b-9ff7-4d4b-88e8-871ac0c95c7b
3. Backend :
https://www.loom.com/share/d32ac1f69e454fbab57841eb05fe958a?sid=1b64a82b-9707-4481-908b-3f087d283069
PROJECT SNAPSHOTS ->
--------------------------------------------------------------------------------------------------------
