Skip to content

Livedocs is a collaborative document editing platform that empowers users to create, share, and collaborate on documents in real-time. With robust features like markdown support, inline commenting, and the ability to mention collaborators, Livedocs makes teamwork seamless and efficient.

Notifications You must be signed in to change notification settings

Akaikenlol/live_docs

Repository files navigation

Livedocs

Livedocs is a collaborative document editing platform that allows users to create, share, and edit documents in real-time with other users. Designed with modern technologies, Livedocs ensures a secure, efficient, and user-friendly experience for all your document collaboration needs.

Features

  • Document Sharing: Easily share your documents with others.
  • Real-time Collaboration: Collaborate with other users on the same document in real-time.
  • Document Management: Create and delete documents effortlessly.
  • Markdown Support: Utilize markdown for formatting and organizing content.
  • Inline Comments: Add comments on every single line of the document.
  • User Mentions: Mention other users within comment sections.
  • Emoji Reactions: React to comments with emojis.
  • Thread Resolution: Resolve comment threads to keep discussions organized.

Tech Stack

  • Authentication: Clerk for secure and easy user authentication.
  • Framework: Next.js for a robust and scalable application foundation.
  • Styling: TailwindCSS for modern, responsive design.
  • UI Components: shadcnui for pre-built, customizable UI components.
  • Type Safety: TypeScript for type-safe coding and reduced runtime errors.
  • Editor: Lexical for a powerful and flexible document editor.
  • Collaboration: Liveblocks for real-time collaborative experiences.
  • Performance Monitoring: Sentry for monitoring and ensuring the security and performance of the app.

Getting Started

To run this project locally:

  1. Clone the repository:
    git clone https://github.com/yourusername/livedocs.git
  2. Install dependencies:
        cd livedocs
        npm install
  3. Configure environment variables for Clerk, Sentry, and Liveblocks as needed.
  4. Run the development server:
        npm run dev
  5. Open http://localhost:3000 to view it in the browser.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

About

Livedocs is a collaborative document editing platform that empowers users to create, share, and collaborate on documents in real-time. With robust features like markdown support, inline commenting, and the ability to mention collaborators, Livedocs makes teamwork seamless and efficient.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published