This is a Google Docs clone built with Next.js 15, React, Tailwind CSS, and real-time collaboration features using Liveblocks, Convex, and Clerk for authentication.
⭐ Please give a star to my repo; it will help me a lot! ⭐
- Real-time collaboration
- Rich text editing with support for:
- Tables
- Images with resizing
- Task lists
- and many more...
- Customizable themes with Tailwind CSS
- Responsive design
- Toolbar for common actions
Before you begin, ensure you have the following:
- Node.js installed on your machine
- An account on Convex
- An account on Clerk
- An account on Liveblocks
-
Clone the repository:
git clone https://github.com/sufiprog/docs-clone.git cd docs-clone npm install
-
Set up Convex:
- Create an account on Convex and create a new project.
- Follow the instructions to set up your database.
- Copy the Convex deployment URL and secret code.
-
Set up Clerk:
- Create an account on Clerk and create a new application.
- Copy the Clerk publishable key and secret key.
-
Set up Liveblocks:
- Create an account on Liveblocks and create a new project.
- Copy the Liveblocks public key and secret key.
-
Create a
.env.local
file:-
Add the following environment variables to the file in the root directory of your project:
CONVEX_DEPLOYMENT=your_convex_secret_code NEXT_PUBLIC_CONVEX_URL=your_convex_public_url NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key CLERK_SECRET_KEY=your_clerk_secret_key LIVE_BLOCK_SECRET_KEY=your_liveblocks_secret_key
-
-
Run the development server:
npm run dev
Open http://localhost:3000 with your browser to see the result.
The easiest way to deploy your Next.js app is to use the Vercel Platform, created by the Next.js team.
- Sign up for a Vercel account if you don’t have one.
- Import your project from GitHub.
- Add the same environment variables in the Vercel dashboard.
- Deploy your project.
To learn more about the technologies used in this project, take a look at the following resources:
- Next.js Documentation - Learn about Next.js features and API.
- Convex Documentation - Learn about Convex features and API.
- Clerk Documentation - Learn about Clerk features and API.
- Liveblocks Documentation - Learn about Liveblocks features and API.
Contributions are welcome! Please open an issue or submit a pull request for any improvements or bug fixes.
This project is licensed under the MIT License.