BoardFlow - Cooperative Whiteboard App

Welcome to BoardFlow, a collaborative whiteboard application built using Next.js 14.0, Tailwind CSS, TypeScript, Clerk, Convex, and Liveblocks. This app empowers users to create organizations, join existing ones, and collaboratively work on boards where they can utilize various tools such as text, notes, rectangles, circles, images, and pencils. Users can manipulate objects on the whiteboard by selecting, resizing, deleting, or changing their layering order.

Table of Contents

• Features
• Getting Started
• Technologies Used
• Installation
• Usage
• Contributing
• License

Features

• Organization Management: Users can create and join organizations to collaborate with teammates.
• Interactive Whiteboard: Create boards within organizations and use various tools to express ideas collaboratively.
• Object Manipulation: Select, resize, delete, or change the layering order of objects on the whiteboard.
• Toolset: Utilize a diverse set of tools, including text, notes, rectangles, circles, images, and pencils.

Getting Started

Prerequisites

Make sure you have the following installed:

• Node.js
• npm or yarn

Installation

1. Clone the repository:

   git clone https://github.com/Biplo12/BoardFlow.git
   

2. Navigate to the project directory:

   cd boardflow
   

3. Install dependencies:

   npm install
   # or
   yarn install
   

Technologies Used

• Next.js - React framework for server-rendered React applications.
• Tailwind CSS - A utility-first CSS framework.
• TypeScript - Superset of JavaScript that adds static typing.
• Clerk - Authentication and user management.
• Convex - Real-time collaboration and synchronization.
• Liveblocks - Real-time collaboration infrastructure.

Usage

1. Run the development server:

   npm run dev
   # or
   yarn dev
   

2. Open your browser and navigate to http://localhost:3000.

3. Start collaborating with your team on the cooperative whiteboard!

Contributing

Contributions are welcome!

License

This project is licensed under the MIT License