README.md

Miro Clone With Nextjs

🛠️ Build a Custom Whiteboard 🧰 Tools for Text, Shapes, Sticky Notes & Pencil 🪄 Layer Management 🎨 Color Palette Options ↩️ Undo & Redo Actions ⌨️ Keyboard Shortcuts 🤝 Collaborate in Real Time 💾 Live Database Integration 🔐 Authentication, Organizations & Invites ⭐️ Favorite Items for Quick Access 🌐 Powered by Next.js 14

View Demo · Documentation · Report Bug · Request Feature

📔 Table of Contents

• About the Project
  • Screenshots
  • Tech Stack
  • Environment Variables
• Getting Started
  • Prerequisites
  • Installation
  • Run Locally
  • Deployment
• Contact

🌟 About the Project

📷 Screenshots

LIVE DEMO 💥

👾 Tech Stack

Client

• Typescript
• Next.js
• React.js
• TailwindCSS
• Prisma

Database

• Mongodb
• Cloudinary

🧰 Getting Started

‼️ Prerequisites

• Install Node JS in your computer HERE
• Sign up for a clerk account HERE
• Sign up for a convex HERE
• Sign up for a liveblocks HERE

🔑 Environment Variables

To run this project, you will need to add the following environment variables to your .env file

CONVEX_DEPLOYMENT

NEXT_PUBLIC_CONVEX_URL

NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY

CLERK_SECRET_KEY

LIVEBLOCKS_SECRET_KEY

This project was bootstrapped with Create React App.

⚙️ Installation

Install my-project with npm

npx create-next-app@latest my-project --typescript --eslint

cd my-project

Install dependencies

🧪 Install Tailwind CSS with Next.js

Install Tailwind CSS

Install tailwindcss and its peer dependencies via npm, and then run the init command to generate both tailwind.config.js and postcss.config.js.

npm install -D tailwindcss postcss autoprefixer

npx tailwindcss init -p

Configure your template paths

Add the paths to all of your template files in your tailwind.config.js file.

/** @type {import('tailwindcss').Config} */
module.exports = {
  content: [
    "./app/**/*.{js,ts,jsx,tsx}",
    "./pages/**/*.{js,ts,jsx,tsx}",
    "./components/**/*.{js,ts,jsx,tsx}",

    // Or if using `src` directory:
    "./src/**/*.{js,ts,jsx,tsx}",
  ],
  theme: {
    extend: {},
  },
  plugins: [],
};

Add the Tailwind directives to your CSS

Add the @tailwind directives for each of Tailwind’s layers to your ./styles/globals.css file.

@tailwind base;
@tailwind components;
@tailwind utilities;

Install dependencies

🔶 Dependency Info

🏃 Run Locally

Clone the project

  https://github.com/SashenJayathilaka/Miro-Clone.git

change directory

  cd Miro-Clone

Install dependencies

  npm install

Start the server

  npm run dev

---

This is a Next.js project bootstrapped with create-next-app.

---

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.js. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.js.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

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

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

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

🚩 Deployment

To deploy this project run

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 our Next.js deployment documentation for more details.

🤝 Contact

Sashen - @twitter_handle - sashenjayathilaka95@gmail.com

Project Link: https://github.com/SashenJayathilaka/Airbnb-Build.git

Don't forget to leave a star ⭐️