Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hrc-123/collaborativequill
Share yours docs effectively in real time
https://github.com/hrc-123/collaborativequill
mongodb-database quilljs react reactjs socket-io tailwind uuid
Last synced: 28 days ago
JSON representation
Share yours docs effectively in real time
- Host: GitHub
- URL: https://github.com/hrc-123/collaborativequill
- Owner: HRC-123
- Created: 2024-06-14T18:08:10.000Z (5 months ago)
- Default Branch: master
- Last Pushed: 2024-06-19T08:28:21.000Z (5 months ago)
- Last Synced: 2024-10-10T05:40:55.344Z (28 days ago)
- Topics: mongodb-database, quilljs, react, reactjs, socket-io, tailwind, uuid
- Language: JavaScript
- Homepage: https://collaborativequill.onrender.com
- Size: 709 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Collaborative Quill
Collaborative Quill is a project developed to efficiently share documents in real time
Website : [CollaborativeQuill](https://collaborativequill.onrender.com)
## Technologies Used
- Reactjs
- Tailwind
- Quilljs
- Socket-io
- Uuid
- Mongo DB
## Features
- Real-time Collaboration
- Document Sharing
- Interactive Content
- Dynamic Loading
- Customizable Document Names
- Code Integration
- Multimedia Support
## Installation
Use the package manager [npm](https://www.npmjs.com/) to install Collaborative Quill.
```bash
# Clone the repo
git clone https://github.com/HRC-123/CollaborativeQuill.git
# Navigate to client and install the packages required in terminal 1
cd client
npm install
# Navigate to client and install the packages required in terminal 2
cd server
npm install
# Prerequisites before using the app
# Go to client/src/Components/Editor.jsx
# Replace the socketServer with - const socketServer = io("http://localhost:9000");
# Go to server/index.js
# Replace the origin with - origin: "http://localhost:3000",
```
## Usage
```bash
# In terminal 1 i.e client
npm start
# In terminal 2 i.e server
npm start
```
## Contributing
Pull requests are welcome.
For major changes, please open an issue first to discuss what you would like to change.
Only genuine pull requests are merged.
## Hosted
The website is hosted on [Render](https://render.com/)
## Authors
- [@HRC-123](https://github.com/HRC-123)