LiveDocs is a collaborative document editing application built with Next.js, TypeScript, and Tailwind CSS. It offers real-time editing, document management, and interactive commenting features. This project is designed to mimic the functionality of Google Docs, providing a powerful tool for team collaboration and document management.
- Real-Time Collaborative Editing: Multiple users can edit documents simultaneously with live updates.
- Document Management: Create, delete, share, list, and search documents efficiently.
- Comments and Threading: Add and manage comments, including threaded discussions.
- Active Collaborators: See who is currently viewing or editing the document.
- Notifications: Get notified of document shares, new comments, and collaborator activities.
- Secure Authentication: Utilizes Clerk for user authentication to ensure secure access.
- Frontend: Next.js, TypeScript, Tailwind CSS
- Backend: Convex
- Editor: Lexical Editor
- UI Components: ShadCN
- Live Demo : Check out the live version of LiveDocs to see its features in action.
- Project Overview Video: Watch a video demonstration of the project, including its main features and functionality.
-
Clone the Repository:
git clone https://github.com/your-username/livedocs.git
-
Navigate to the Project Directory:
cd livedocs
-
Install Dependencies:
npm install
-
Run the Development Server:
npm run dev
Your application will be available at
http://localhost:3000
.
If you'd like to contribute to LiveDocs, please follow these steps:
- Fork the repository.
- Create a new branch (git checkout -b feature/YourFeature).
- Make your changes and commit them (git commit -am 'Add some feature').
- Push to the branch (git push origin feature/YourFeature).
- Create a new Pull Request.
This project, LiveDocs, is licensed under the MIT License.
A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.
- Commercial use
- Modification
- Distribution
- Private use
- Liability
- Warranty
- License and copyright notice
- Clerk for authentication
- Lexical for the rich text editor
- Convex for backend services
- ShadCN for UI components
- Tailwind CSS for styling