https://github.com/bouzayenilyes/pick_doc

Collaborative application by building LiveDocs, an improved Google Docs that manages millions of collaborators in real-time.
https://github.com/bouzayenilyes/pick_doc

clerk liveblocks nextjs14 shadcn-ui tailwindcss

Last synced: 21 days ago
JSON representation

Collaborative application by building LiveDocs, an improved Google Docs that manages millions of collaborators in real-time.

• Host: GitHub
• URL: https://github.com/bouzayenilyes/pick_doc
• Owner: bouzayenilyes
• Created: 2024-08-09T11:49:25.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-08-09T12:36:37.000Z (5 months ago)
• Last Synced: 2024-08-10T13:09:39.812Z (5 months ago)
• Topics: clerk, liveblocks, nextjs14, shadcn-ui, tailwindcss
• Language: TypeScript
• Homepage: https://pickdoc.vercel.app
• Size: 583 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


## 🤸 Quick Start

Follow these steps to set up the project locally on your machine.

**Prerequisites**

Make sure you have the following installed on your machine:

- [Git](https://git-scm.com/)

- [Node.js](https://nodejs.org/en)

- [npm](https://www.npmjs.com/) (Node Package Manager)

**Cloning the Repository**

```bash

git clone https://github.com/bouzayenilyes/pick_doc.git

cd collaborative-editor

```

**Installation**

Install the project dependencies using npm:

```bash

npm install

```

**Set Up Environment Variables**

Create a new file named `.env` in the root of your project and add the following content:

```env

#Clerk

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=

CLERK_SECRET_KEY=

NEXT_PUBLIC_CLERK_SIGN_IN_URL=/sign-in

NEXT_PUBLIC_CLERK_SIGN_UP_URL=/sign-up

#Liveblocks

NEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY=

LIVEBLOCKS_SECRET_KEY=

```

Replace the placeholder values with your actual Clerk & LiveBlocks credentials. You can obtain these credentials by signing up on the [Clerk](https://clerk.com/) and [Liveblocks](liveblocks.io/) website.

**Running the Project**

```bash

npm run dev

```

Open [http://localhost:3000](http://localhost:3000) in your browser to view the project.