Sync Board

🌎 Visit Site

• Sync Board is a real-time collaborative document editor built with Next.js 15 and Tiptap Editor. It enables users to create and edit various types of documents in real time, leveraging Liveblocks for seamless collaboration. Users can mention others in documents, chat while editing, and use prebuilt templates to kickstart their work. Additionally, Sync Board allows saving documents in multiple formats.

Features

🚀 Real-Time Collaboration

• Users can edit documents simultaneously.
• Changes are reflected instantly using Liveblocks.

💬 User Mentions & Chat

• Mention other users within the document.
• Engage in inline discussions while editing.

📄 Prebuilt Templates

• Various document templates to choose from.
• Saves time by providing ready-made structures.

💾 Export & Save Documents

• Save files in multiple formats (PDF, Markdown, etc.).
• Download documents easily.

🎨 Beautiful UI

• Styled with Tailwind CSS for a modern and responsive experience.

Tech Stack

• Frontend: Next.js 15, React, Tailwind CSS
• Editor: Tiptap
• Real-Time Collaboration: Liveblocks
• Authentication: Clerk
• Deployment: Vercel

---

Installation & Setup

1. Clone the repository:

   git clone https://github.com/KanadShee-18/SyncBoard.git

2. Install dependencies:

   npm install --legacy-peer-deps

   for yarn or bun it will be simple,

   bun install or, yarn install
   

3. Set up environment variables:

   CONVEX_DEPLOYMENT=your_api_key
   NEXT_PUBLIC_CONVEX_URL=generated through npx convex dev
   NEXT_PUBLIC_CLERK_PUBLISHABLE_KEY=your_clerk_publishable_key
   CLERK_SECRET_KEY=clerk_secret_key
   LIVEBLOCKS_SECRET_KEY=liveblocks_secret
   

4. Run the development server:

   npm run dev

   and also

   npx convex dev
   

5. Open http://localhost:3000 in your browser and see how cool it is.

Usage

1. Sign in and create a new document.
2. Choose a template or start from scratch.
3. Mention collaborators and edit in real-time.
4. Save or export your document in the desired format.

Contributing

We welcome contributions! Feel free to:

• Open issues for bugs or feature requests.
• Submit pull requests for improvements.

---

📞 Connect with Us

For any queries or feedback, reach out via GitHub Issues.

---

THANK YOU !