{"id":23439666,"url":"https://github.com/sanidhyy/miro-clone","last_synced_at":"2025-04-13T08:09:16.713Z","repository":{"id":226891367,"uuid":"755568231","full_name":"sanidhyy/miro-clone","owner":"sanidhyy","description":"Revolutionary Miro clone: Real-time collaboration, versatile canvas, rich media, secure.","archived":false,"fork":false,"pushed_at":"2024-12-19T16:26:31.000Z","size":9647,"stargazers_count":49,"open_issues_count":0,"forks_count":16,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-13T08:08:59.804Z","etag":null,"topics":["convex","css","html","javascript","js","liveblocks","next","nextjs","radix-ui","react","shadcn","shadcn-ui","tailwind","tailwindcss","ts","typescript"],"latest_commit_sha":null,"homepage":"https://clone-miro.vercel.app/","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sanidhyy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["sanidhyy"],"patreon":"sanidhy","custom":"https://www.buymeacoffee.com/sanidhy"}},"created_at":"2024-02-10T15:59:04.000Z","updated_at":"2025-04-12T11:34:41.000Z","dependencies_parsed_at":"2024-12-19T17:25:23.775Z","dependency_job_id":"85f59663-9f51-48a8-8882-367701bd9959","html_url":"https://github.com/sanidhyy/miro-clone","commit_stats":null,"previous_names":["sanidhyy/miro-clone"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanidhyy%2Fmiro-clone","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanidhyy%2Fmiro-clone/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanidhyy%2Fmiro-clone/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sanidhyy%2Fmiro-clone/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sanidhyy","download_url":"https://codeload.github.com/sanidhyy/miro-clone/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248681490,"owners_count":21144700,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["convex","css","html","javascript","js","liveblocks","next","nextjs","radix-ui","react","shadcn","shadcn-ui","tailwind","tailwindcss","ts","typescript"],"created_at":"2024-12-23T15:33:11.919Z","updated_at":"2025-04-13T08:09:16.688Z","avatar_url":"https://github.com/sanidhyy.png","language":"TypeScript","funding_links":["https://github.com/sponsors/sanidhyy","https://patreon.com/sanidhy","https://www.buymeacoffee.com/sanidhy"],"categories":[],"sub_categories":[],"readme":"\u003ca name=\"readme-top\"\u003e\u003c/a\u003e\n\n# Miro Clone - Real-time collaboration, versatile canvas, rich media, secure.\n\n![Miro Clone - Real-time collaboration, versatile canvas, rich media, secure.](/.github/images/img_main.png \"Miro Clone - Real-time collaboration, versatile canvas, rich media, secure.\")\n\n[![Ask Me Anything!](https://flat.badgen.net/static/Ask%20me/anything?icon=github\u0026color=black\u0026scale=1.01)](https://github.com/sanidhyy \"Ask Me Anything!\")\n[![GitHub license](https://flat.badgen.net/github/license/sanidhyy/miro-clone?icon=github\u0026color=black\u0026scale=1.01)](https://github.com/sanidhyy/miro-clone/blob/main/LICENSE \"GitHub license\")\n[![Maintenance](https://flat.badgen.net/static/Maintained/yes?icon=github\u0026color=black\u0026scale=1.01)](https://github.com/sanidhyy/miro-clone/commits/main \"Maintenance\")\n[![GitHub branches](https://flat.badgen.net/github/branches/sanidhyy/miro-clone?icon=github\u0026color=black\u0026scale=1.01)](https://github.com/sanidhyy/miro-clone/branches \"GitHub branches\")\n[![Github commits](https://flat.badgen.net/github/commits/sanidhyy/miro-clone?icon=github\u0026color=black\u0026scale=1.01)](https://github.com/sanidhyy/miro-clone/commits \"Github commits\")\n[![GitHub issues](https://flat.badgen.net/github/issues/sanidhyy/miro-clone?icon=github\u0026color=black\u0026scale=1.01)](https://github.com/sanidhyy/miro-clone/issues \"GitHub issues\")\n[![GitHub pull requests](https://flat.badgen.net/github/prs/sanidhyy/miro-clone?icon=github\u0026color=black\u0026scale=1.01)](https://github.com/sanidhyy/miro-clone/pulls \"GitHub pull requests\")\n[![Vercel status](https://img.shields.io/badge/Vercel-000000?style=for-the-badge\u0026logo=vercel\u0026logoColor=white)](https://clone-miro.vercel.app/ \"Vercel status\")\n\n\u003c!-- Table of Contents --\u003e\n\u003cdetails\u003e\n\n\u003csummary\u003e\n\n# :notebook_with_decorative_cover: Table of Contents\n\n\u003c/summary\u003e\n\n- [Folder Structure](#bangbang-folder-structure)\n- [Getting Started](#toolbox-getting-started)\n- [Screenshots](#camera-screenshots)\n- [Tech Stack](#gear-tech-stack)\n- [Stats](#wrench-stats)\n- [Contribute](#raised_hands-contribute)\n- [Acknowledgements](#gem-acknowledgements)\n- [Buy Me a Coffee](#coffee-buy-me-a-coffee)\n- [Follow Me](#rocket-follow-me)\n- [Learn More](#books-learn-more)\n- [Deploy on Vercel](#page_with_curl-deploy-on-vercel)\n- [Give A Star](#star-give-a-star)\n- [Star History](#star2-star-history)\n- [Give A Star](#star-give-a-star)\n\n\u003c/details\u003e\n\n## :bangbang: Folder Structure\n\nHere is the folder structure of this app.\n\n```bash\nmiro-clone/\n  |- app/\n    |-- (dashboard)/\n        |--- _components/\n            |---- board-card/\n            |---- sidebar/\n            |---- board-list.tsx\n            |---- empty-boards.tsx\n            |---- empty-favourites.tsx\n            |---- empty-org.tsx\n            |---- empty-search.tsx\n            |---- invite-button.tsx\n            |---- navbar.tsx\n            |---- new-board-button.tsx\n            |---- org-sidebar.tsx\n            |---- search-input.tsx\n        |--- layout.tsx\n        |--- page.tsx\n    |-- api/liveblocks-auth/\n        |--- route.ts\n    |-- board/[boardId]/\n        |--- _components/\n            |---- canvas.tsx\n            |---- color-picker.tsx\n            |---- cursor.tsx\n            |---- cursors-presence.tsx\n            |---- ellipse.tsx\n            |---- info.tsx\n            |---- layer-preview.tsx\n            |---- loading.tsx\n            |---- note.tsx\n            |---- participants.tsx\n            |---- path.tsx\n            |---- rectangle.tsx\n            |---- selection-box.tsx\n            |---- selection-tools.tsx\n            |---- text.tsx\n            |---- tool-button.tsx\n            |---- toolbar.tsx\n            |---- user-avatar.tsx\n        |--- page.tsx\n    |-- apple-icon.png\n    |-- favicon.ico\n    |-- globals.css\n    |-- icon1.png\n    |-- icon2.png\n    |-- layout.tsx\n  |- components/\n    |-- auth/\n    |-- modals/\n    |-- ui/\n    |-- actions.tsx\n    |-- confirm-modal.tsx\n    |-- hint.tsx\n    |-- room.tsx\n  |- config/\n    |-- index.ts\n  |- convex/\n    |-- _generated/\n    |-- auth.config.js\n    |-- board.ts\n    |-- boards.ts\n    |-- schema.ts\n    |-- tsconfig.json\n  |- hooks/\n    |-- use-api-mutation.tsx\n    |-- use-disable-scroll-bounce.tsx\n    |-- use-selection-bounds.tsx\n  |- lib/\n    |-- utils.ts\n  |- providers/\n    |-- convex-client-provider.tsx\n    |-- modal-provider.tsx\n  |- public/\n    |-- placeholders/\n    |-- elements.svg\n    |-- empty-boards.svg\n    |-- empty-favourites.svg\n    |-- empty-search.svg\n    |-- logo.svg\n  |- store/\n    |-- use-rename-modal.ts\n  |- types/\n    |-- canvas.ts\n  |- .env.local\n  |- .env.local.example\n  |- .eslintrc.json\n  |- .gitignore\n  |- components.json\n  |- environment.d.ts\n  |- liveblocks.config.ts\n  |- middleware.ts\n  |- next.config.mjs\n  |- package-lock.json\n  |- package.json\n  |- postcss.config.js\n  |- tailwind.config.ts\n  |- tsconfig.json\n```\n\n\u003cbr /\u003e\n\n## :toolbox: Getting Started\n\n1. Make sure **Git** and **NodeJS** is installed.\n2. Clone this repository to your local computer.\n3. Create `.env.local` file in **root** directory.\n4. Contents of `.env.local`:\n\n```env\n# .env.local\n\n# disable next.js telemetry\nNEXT_TELEMETRY_DISABLED=1\n\n# deployment for convex\nCONVEX_DEPLOYMENT=dev:convex-app-name # team: \u003cyour-team-name\u003e, project: \u003cyour-project-name\u003e\n\n# convex deployment url\nNEXT_PUBLIC_CONVEX_URL=https://convex-app-name.convex.cloud\n\n# clerk auth keys\nNEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=pk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\nCLERK_SECRET_KEY=sk_test_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n\n# liveblocks api keys\nNEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY=pk_dev_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\nNEXT_PUBLIC_LIVEBLOCKS_SECRET_KEY=sk_dev_XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n\n```\n\n### 5. Convex Deployment Configuration:\n\n#### a. Visit the Convex Website:\n\n- Go to the [Convex website](https://convex.cloud/) and sign in to your account.\n\n#### b. Access Deployment Settings:\n\n- Navigate to the deployment settings section in your Convex account.\n\n#### c. Retrieve Deployment Configuration:\n\n- Find the deployment details, including team and project names.\n- Update the `CONVEX_DEPLOYMENT` variable in the `.env.local` file with the obtained information.\n\n### 6. Clerk Authentication Keys:\n\n#### a. Visit the Clerk Website:\n\n- Go to the [Clerk website](https://clerk.dev/) and sign in to your Clerk account.\n\n#### b. Access API Keys:\n\n- Find the section in your Clerk account related to API keys or authentication settings.\n\n#### c. Generate Keys:\n\n- Generate a pair of keys (Publishable Key and Secret Key).\n\n#### d. Update `.env.local`:\n\n- Replace the `NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY` and `CLERK_SECRET_KEY` variables in the `.env.local` file with the keys obtained from Clerk.\n\n### 7. Liveblocks API Keys:\n\n#### a. Visit the Liveblocks Website:\n\n- Go to the [Liveblocks website](https://liveblocks.io/) and sign in to your Liveblocks account.\n\n#### b. Access API Keys:\n\n- Navigate to your Liveblocks account settings or API keys section.\n\n#### c. Generate Keys:\n\n- Generate a pair of keys (Public Key and Secret Key) for development.\n\n#### d. Update `.env.local`:\n\n- Replace the `NEXT_PUBLIC_LIVEBLOCKS_PUBLIC_KEY` and `NEXT_PUBLIC_LIVEBLOCKS_SECRET_KEY` variables in the `.env.local` file with the Liveblocks API keys obtained.\n\n### 8. Save and Secure:\n\n- Save the changes to the `.env.local` file.\n\n9. Install Project Dependencies using `npm install --legacy-peer-deps` or `yarn install --legacy-peer-deps`.\n10. Now app is fully configured 👍 and you can start using this app using either one of `npm run dev` or `yarn dev`.\n\n**NOTE:** Please make sure to keep your API keys and configuration values secure and do not expose them publicly.\n\n## :camera: Screenshots\n\n![Modern UI/UX](/.github/images/img1.png \"Modern UI/UX\")\n\n![Create New Boards](/.github/images/img2.png \"Create New Boards\")\n\n![Rename Boards](/.github/images/img3.png \"Rename Boards\")\n\n## :gear: Tech Stack\n\n[![React JS](https://skillicons.dev/icons?i=react \"React JS\")](https://react.dev/ \"React JS\") [![Next JS](https://skillicons.dev/icons?i=next \"Next JS\")](https://nextjs.org/ \"Next JS\") [![Typescript](https://skillicons.dev/icons?i=ts \"Typescript\")](https://www.typescriptlang.org/ \"Typescript\") [![Tailwind CSS](https://skillicons.dev/icons?i=tailwind \"Tailwind CSS\")](https://tailwindcss.com/ \"Tailwind CSS\") [![Vercel](https://skillicons.dev/icons?i=vercel \"Vercel\")](https://vercel.app/ \"Vercel\") [![MySQL](https://skillicons.dev/icons?i=mysql \"MySQL\")](https://mysql.com/ \"MySQL\")\n\n## :wrench: Stats\n\n[![Stats for Miro Clone](/.github/images/stats.svg \"Stats for Miro Clone\")](https://pagespeed.web.dev/analysis?url=https://clone-miro.vercel.app/ \"Stats for Miro Clone\")\n\n## :raised_hands: Contribute\n\nYou 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.\n\n## :gem: Acknowledgements\n\nUseful resources and dependencies that are used in Miro Clone.\n\n- Thanks to CodeWithAntonio: https://codewithantonio.com/\n- [@clerk/nextjs](https://www.npmjs.com/package/@clerk/nextjs): ^4.29.7\n- [@liveblocks/client](https://www.npmjs.com/package/@liveblocks/client): ^1.10.1\n- [@liveblocks/node](https://www.npmjs.com/package/@liveblocks/node): ^1.10.1\n- [@liveblocks/react](https://www.npmjs.com/package/@liveblocks/react): ^1.10.1\n- [@radix-ui/react-alert-dialog](https://www.npmjs.com/package/@radix-ui/react-alert-dialog): ^1.0.5\n- [@radix-ui/react-avatar](https://www.npmjs.com/package/@radix-ui/react-avatar): ^1.0.4\n- [@radix-ui/react-dialog](https://www.npmjs.com/package/@radix-ui/react-dialog): ^1.0.5\n- [@radix-ui/react-dropdown-menu](https://www.npmjs.com/package/@radix-ui/react-dropdown-menu): ^2.0.6\n- [@radix-ui/react-slot](https://www.npmjs.com/package/@radix-ui/react-slot): ^1.0.2\n- [@radix-ui/react-tooltip](https://www.npmjs.com/package/@radix-ui/react-tooltip): ^1.0.7\n- [class-variance-authority](https://www.npmjs.com/package/class-variance-authority): ^0.7.0\n- [clsx](https://www.npmjs.com/package/clsx): ^2.1.0\n- [convex](https://www.npmjs.com/package/convex): ^1.9.0\n- [convex-helpers](https://www.npmjs.com/package/convex-helpers): ^0.1.23\n- [date-fns](https://www.npmjs.com/package/date-fns): ^3.3.1\n- [lucide-react](https://www.npmjs.com/package/lucide-react): ^0.323.0\n- [nanoid](https://www.npmjs.com/package/nanoid): ^5.0.6\n- [next](https://www.npmjs.com/package/next): 14.1.0\n- [next-themes](https://www.npmjs.com/package/next-themes): ^0.2.1\n- [perfect-freehand](https://www.npmjs.com/package/perfect-freehand): ^1.2.2\n- [query-string](https://www.npmjs.com/package/query-string): ^8.2.0\n- [react](https://www.npmjs.com/package/react): ^18\n- [react-contenteditable](https://www.npmjs.com/package/react-contenteditable): ^3.3.7\n- [react-dom](https://www.npmjs.com/package/react-dom): ^18\n- [sonner](https://www.npmjs.com/package/sonner): ^1.4.0\n- [tailwind-merge](https://www.npmjs.com/package/tailwind-merge): ^2.2.1\n- [tailwindcss-animate](https://www.npmjs.com/package/tailwindcss-animate): ^1.0.7\n- [usehooks-ts](https://www.npmjs.com/package/usehooks-ts): ^2.14.0\n- [zustand](https://www.npmjs.com/package/zustand): ^4.5.1\n\n## :coffee: Buy Me a Coffee\n\n[\u003cimg src=\"https://img.shields.io/badge/Buy_Me_A_Coffee-FFDD00?style=for-the-badge\u0026logo=buy-me-a-coffee\u0026logoColor=black\" width=\"200\" /\u003e](https://www.buymeacoffee.com/sanidhy \"Buy me a Coffee\")\n\n## :rocket: Follow Me\n\n[![Follow Me](https://img.shields.io/github/followers/sanidhyy?style=social\u0026label=Follow\u0026maxAge=2592000)](https://github.com/sanidhyy \"Follow Me\")\n[![Tweet about this project](https://img.shields.io/twitter/url?style=social\u0026url=https%3A%2F%2Ftwitter.com%2FTechnicalShubam)](https://twitter.com/intent/tweet?text=Check+out+this+amazing+app:\u0026url=https%3A%2F%2Fgithub.com%2Fsanidhyy%2Fmiro-clone \"Tweet about this project\")\n[![Subscribe to my YouTube Channel](https://img.shields.io/youtube/channel/subscribers/UCNAz_hUVBG2ZUN8TVm0bmYw)](https://www.youtube.com/@OPGAMER./?sub_confirmation=1 \"Subscribe to my YouTube Channel\")\n\n## :books: Learn More\n\nTo learn more about Next.js, take a look at the following resources:\n\n- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.\n- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.\n\nYou can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!\n\n## :page_with_curl: Deploy on Vercel\n\nThe easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template\u0026filter=next.js\u0026utm_source=create-next-app\u0026utm_campaign=create-next-app-readme) from the creators of Next.js.\n\nCheck out [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.\n\n## :star: Give A Star\n\nYou can also give this repository a star to show more people and they can use this repository.\n\n## :star2: Star History\n\n\u003ca href=\"https://star-history.com/#sanidhyy/miro-clone\u0026Timeline\"\u003e\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"https://api.star-history.com/svg?repos=sanidhyy/miro-clone\u0026type=Timeline\u0026theme=dark\" /\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://api.star-history.com/svg?repos=sanidhyy/miro-clone\u0026type=Timeline\" /\u003e\n  \u003cimg alt=\"Star History Chart\" src=\"https://api.star-history.com/svg?repos=sanidhyy/miro-clone\u0026type=Timeline\" /\u003e\n\u003c/picture\u003e\n\u003c/a\u003e\n\n\u003cbr /\u003e\n\u003cp align=\"right\"\u003e(\u003ca href=\"#readme-top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanidhyy%2Fmiro-clone","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsanidhyy%2Fmiro-clone","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsanidhyy%2Fmiro-clone/lists"}