Skip to content

Collaborative document editor with real-time editing, comments, and notifications. Built with Next.js, TypeScript, and Liveblocks.

License

Notifications You must be signed in to change notification settings

ayushbansal111/LiveDocs

Repository files navigation

LiveDocs

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.

Features

  • 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.

Tech Stack

  • Frontend: Next.js, TypeScript, Tailwind CSS
  • Backend: Convex
  • Editor: Lexical Editor
  • UI Components: ShadCN

Demo

  • Live Demo : Check out the live version of LiveDocs to see its features in action.

Video

  • Project Overview Video: Watch a video demonstration of the project, including its main features and functionality.

Getting Started

  1. Clone the Repository:

    git clone https://github.com/your-username/livedocs.git
  2. Navigate to the Project Directory:

    cd livedocs
  3. Install Dependencies:

    npm install
  4. Run the Development Server:

    npm run dev

    Your application will be available at http://localhost:3000.

Contributing

If you'd like to contribute to LiveDocs, please follow these steps:

  1. Fork the repository.
  2. Create a new branch (git checkout -b feature/YourFeature).
  3. Make your changes and commit them (git commit -am 'Add some feature').
  4. Push to the branch (git push origin feature/YourFeature).
  5. Create a new Pull Request.

License

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.

Permissions

  • Commercial use
  • Modification
  • Distribution
  • Private use

Limitations

  • Liability
  • Warranty

Conditions

  • License and copyright notice

Acknowledgments

About

Collaborative document editor with real-time editing, comments, and notifications. Built with Next.js, TypeScript, and Liveblocks.

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published