Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sashenjayathilaka/miro-clone
🛠️ 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
https://github.com/sashenjayathilaka/miro-clone
class-variance-authority clerk-react convex date-fns liveblocks lucide-react nanoid nextjs nodejs perfect-freehand query-string radix-ui react-contenteditable react-dom react-loader-spinner sonner tailwindcss typescript usehooks-ts zustand
Last synced: 28 days ago
JSON representation
🛠️ 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
- Host: GitHub
- URL: https://github.com/sashenjayathilaka/miro-clone
- Owner: SashenJayathilaka
- Created: 2024-02-04T22:12:33.000Z (12 months ago)
- Default Branch: main
- Last Pushed: 2024-12-07T04:01:12.000Z (about 2 months ago)
- Last Synced: 2025-01-03T05:31:52.997Z (29 days ago)
- Topics: class-variance-authority, clerk-react, convex, date-fns, liveblocks, lucide-react, nanoid, nextjs, nodejs, perfect-freehand, query-string, radix-ui, react-contenteditable, react-dom, react-loader-spinner, sonner, tailwindcss, typescript, usehooks-ts, zustand
- Language: TypeScript
- Homepage: https://miro-clone-jade.vercel.app
- Size: 671 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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
## :notebook_with_decorative_cover: Table of Contents
- [About the Project](#star2-about-the-project)
- [Screenshots](#camera-screenshots)
- [Tech Stack](#space_invader-tech-stack)
- [Environment Variables](#key-environment-variables)
- [Getting Started](#toolbox-getting-started)
- [Prerequisites](#bangbang-prerequisites)
- [Installation](#gear-installation)
- [Run Locally](#running-run-locally)
- [Deployment](#triangular_flag_on_post-deployment)
- [Contact](#handshake-contact)
## :star2: About the Project
### :camera: Screenshots
## LIVE DEMO 💥
### :space_invader: Tech Stack
Client
Database
## :toolbox: Getting Started
### :bangbang: 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
### :key: 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](https://github.com/facebook/create-react-app).
### :gear: Installation
Install my-project with npm
```
npx create-next-app@latest my-project --typescript --eslint
```
```
cd my-project
```
Install dependencies
### :test_tube: 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.
```js
/** @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.
```css
@tailwind base;
@tailwind components;
@tailwind utilities;
```
Install dependencies
### :running: Run Locally
Clone the project
```bash
https://github.com/SashenJayathilaka/Miro-Clone.git
```
change directory
```bash
cd Miro-Clone
```
Install dependencies
```bash
npm install
```
Start the server
```bash
npm run dev
```
This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
Open [http://localhost:3000](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](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](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](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
### Learn More
To learn more about Next.js, take a look at the following resources:
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
### :triangular_flag_on_post: Deployment
To deploy this project run
##### Deploy on Vercel
The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.
## :handshake: Contact
Sashen - [@twitter_handle](https://twitter.com/SashenHasinduJ) - [email protected]
Project Link: [https://github.com/SashenJayathilaka/Airbnb-Build.git](https://github.com/SashenJayathilaka/Airbnb-Build.git)