Got it! Here's the updated README:
Welcome to Live Docs, a real-time collaborative document editing application with live cursors, built using Liveblocks.
- Real-time Collaboration: Multiple users can edit documents simultaneously.
- Live Cursors: See where others are editing in real-time with live cursors.
- User Presence: Know who is currently online and active in the document.
- Version Control: Keep track of changes and document versions.
- Frontend: Next.js, Tailwind CSS, Shadcn
- Real-time Collaboration: Liveblocks
- Text Editor: Lexical
Follow these instructions to get the project up and running on your local machine for development and testing purposes.
- Node.js (v14 or higher)
- npm or yarn
- Liveblocks API key (# at Liveblocks to get your API key)
-
Clone the repository:
git clone https://github.com/jaykapade/docs-live.git cd live-docs
-
Install dependencies:
npm install # or yarn install
-
Create a
.env
file in the root directory and add all secrets present in .env.example: -
Start the development server:
npm run dev # or yarn dev
The app should now be running on
http://localhost:3000
.
- Open
http://localhost:3000
in your browser. - Start a new document or join an existing one using a document ID.
- Share the document ID with others to collaborate in real-time.
We welcome contributions to improve Live Docs Edit! To contribute:
- Fork the repository.
- Create a new branch (
git checkout -b feature/your-feature-name
). - Make your changes.
- Commit your changes (
git commit -m 'Add some feature'
). - Push to the branch (
git push origin feature/your-feature-name
). - Open a pull request.
This project is licensed under the MIT License. See the LICENSE file for details.
- Liveblocks for providing real-time collaboration infrastructure.
- Lexical for the powerful text editor.
- Next.js for the robust framework.
- Tailwind CSS for the styling.
- Shadcn for UI components.