google-docs-clone icon indicating copy to clipboard operation
google-docs-clone copied to clipboard

Published 2 weeks ago • verified publisher icon sanidhyy
→

Metadata

Full-stack Realtime Google Docs Clone using Next.js 15 and Convex.

Full-stack Realtime Google Docs Clone using Next.js 15 and Convex

Full-stack Realtime Google Docs Clone using Next.js 15 and Convex

Ask Me Anything! GitHub license Maintenance GitHub branches Github commits GitHub issues GitHub pull requests Vercel status

:notebook_with_decorative_cover: Table of Contents
  • Folder Structure
  • Getting Started
  • Screenshots
  • Tech Stack
  • Stats
  • Contribute
  • Acknowledgements
  • Buy Me a Coffee
  • Follow Me
  • Learn More
  • Deploy on Vercel
  • Give A Star
  • Star History
  • Give A Star

:bangbang: Folder Structure

Here is the folder structure of this app.

google-docs-clone/
  |- convex/
    |-- _generated/
    |-- .env.example
    |-- .env.local
    |-- auth.config.ts
    |-- documents.ts
    |-- environment.d.ts
    |-- schema.ts
  |- public/
    |-- blank-document.svg
    |-- business-letter.svg
    |-- cover-letter.svg
    |-- letter.svg
    |-- logo.svg
    |-- project-proposal.svg
    |-- resume.svg
    |-- software-proposal.svg
  |- src/
    |-- app/
        |--- (home)/
        |--- api/
        |--- documents/
        |--- apple-icon.png
        |--- error.tsx
        |--- favicon.ico
        |--- globals.css
        |--- icon1.png
        |--- icon2.png
        |--- layout.tsx
        |--- not-found.tsx
    |-- components/
        |--- ui/
        |--- convex-client-provider.tsx
        |--- fullscreen-loader.tsx
        |--- remove-dialog.tsx
        |--- rename-dialog.tsx
    |-- config/
        |--- editor.ts
        |--- index.ts
    |-- constants/
        |--- index.ts
    |-- extensions/
        |--- font-size.ts
        |--- line-height.ts
    |-- hooks/
        |--- use-debounce.ts
        |--- use-search-param.tsx
    |-- lib/
        |--- utils.ts
    |-- store
        |--- use-editor-store.ts
    |-- middleware.ts
  |- .env.example
  |- .env.local
  |- .eslintrc.json
  |- .gitignore
  |- .prettierrc.json
  |- .prettierrc.mjs
  |- bun.lockb
  |- components.json
  |- environment.d.ts
  |- liveblocks.config.ts
  |- next.config.ts
  |- package.json
  |- postcss.config.mjs
  |- README.md
  |- tailwind.config.ts
  |- tsconfig.json

:toolbox: Getting Started

  1. Make sure Git and NodeJS is installed.
  2. Clone this repository to your local computer.
  3. Create .env.local file in root and convex directory.
  4. Contents of .env.local:
# disabled clerk and next.js telemetry
NEXT_TELEMETRY_DISABLED=1
CLERK_TELEMETRY_DISABLED=1

# app base url
NEXT_PUBLIC_APP_BASE_URL="http://localhost:3000"

# convex deployment & url
CONVEX_DEPLOYMENT="dev:<deployment-id>" # team: <team-id>, project: <project-id>
NEXT_PUBLIC_CONVEX_URL="https://<deployment-id>.convex.cloud"

# clerk auth keys
NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY="pk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
CLERK_SECRET_KEY="sk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

# liveblocks keys
NEXT_PUBLIC_LIVEBLOCKS_API_KEY="pk_dev_-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
LIVEBLOCKS_SECRET_KEY="sk_dev_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  1. Contents of convex/.env.local:
# clerk issuer url (go to your clerk dashboard > JWT Templates > New template > Convex > Save and copy your Issuer URL)
CLERK_ISSUER_URL=https://example-id.clerk.accounts.dev

6. App Base URL

Set the NEXT_PUBLIC_APP_BASE_URL to http://localhost:3000 where your app will be running locally or in production.

7. Convex Deployment

  • Visit the Convex website: https://convex.dev
  • Log in to your Convex account or sign up if you don't have one.
  • Once logged in, navigate to the "Deployments" section.
  • Create a new deployment or select an existing one.
  • Replace <deployment-name>, <team-name>, and <project-name> in the .env.local file with your Convex deployment details.
  • In the Convex dashboard, find the public URL associated with your deployment.
  • Replace <your-convex-url> in the .env.local file with your Convex public URL.

8. Clerk Authentication Keys

  • Visit the Clerk dashboard: https://clerk.dev
  • Log in to your Clerk account or sign up if you don't have one.
  • Go to the "Projects" section and select your project.
  • Navigate to the "API Keys" tab.
  • Copy the "Publishable Key" and replace <your-clerk-publishable-key> in the .env.local file with the copied key.
  • Copy the "Secret Key" and replace <your-clerk-secret-key> in the .env.local file with the copied key.
  • Go to your Clerk dashboard > JWT Templates > New template > Convex.
  • In the Claims section add "organization_id": "{{org.id}}" along with the existing json values.
  • Click on save and copy the Issuer url.
  • Replace <your-clerk-issuer-url> with the url that you copied.
  • Also, go to Convex dashboard > Settings > Environment Variables > Add CLERK_ISSUER_URL variable with value that you copied.

9. Liveblocks API Keys

  • Visit the Liveblocks website > dashboard.
  • Navigate to API settings or keys section.
  • Generate or locate your API key and secret.
  • Set NEXT_PUBLIC_LIVEBLOCKS_API_KEY and LIVEBLOCKS_SECRET_KEY in the .env file according to the obtained information.

  1. Install Project Dependencies using npm install --legacy-peer-deps or yarn install --legacy-peer-deps or bun install --legacy-peer-deps.

  2. Now app is fully configured 👍 and you can start using this app using either one of npm run dev or yarn dev or bun dev.

NOTE: Please make sure to keep your API keys and configuration values secure and do not expose them publicly.

:camera: Screenshots

Modern UI/UX

Realtime Tiptap Editor

Mentions, Replies and Reactions

:gear: Tech Stack

React JS Next JS Typescript Tailwind CSS Vercel

:wrench: Stats

Stats for Docs

:raised_hands: Contribute

You might encounter some bugs while using this app. You are more than welcome to contribute. Just submit changes via pull request and I will review them before merging. Make sure you follow community guidelines.

:gem: Acknowledgements

Useful resources and dependencies that are used in Docs.

:coffee: Buy Me a Coffee

:rocket: Follow Me

Follow Me Tweet about this project Subscribe to my YouTube Channel

:books: Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

:page_with_curl: Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out Next.js deployment documentation for more details.

:star: Give A Star

You can also give this repository a star to show more people and they can use this repository.

:star2: Star History

Star History Chart

(back to top)

← Metadata

41
Stars
13
Forks
41
Watchers

Owner

verified publisher icon sanidhyy

Metadata

Full-stack Realtime Google Docs Clone using Next.js 15 and Convex.

Back