https://github.com/biplo12/boardflow
BoardFlow: A collaborative whiteboard app powered by Next.js, Tailwind CSS, TypeScript, Clerk, Convex, and Liveblocks. Create organizations, join boards, and use text, notes, shapes, images, and pencils for seamless teamwork.
https://github.com/biplo12/boardflow
clerk convex liveblocks nextjs tailiwndcss typescript
Last synced: about 2 months ago
JSON representation
BoardFlow: A collaborative whiteboard app powered by Next.js, Tailwind CSS, TypeScript, Clerk, Convex, and Liveblocks. Create organizations, join boards, and use text, notes, shapes, images, and pencils for seamless teamwork.
- Host: GitHub
- URL: https://github.com/biplo12/boardflow
- Owner: Biplo12
- Created: 2024-02-08T19:16:06.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-02-16T16:48:23.000Z (over 1 year ago)
- Last Synced: 2025-02-07T02:39:05.387Z (4 months ago)
- Topics: clerk, convex, liveblocks, nextjs, tailiwndcss, typescript
- Language: TypeScript
- Homepage: https://board-flow.vercel.app/
- Size: 2.59 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](#features)
- [Getting Started](#getting-started)
- [Technologies Used](#technologies-used)
- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#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](https://nodejs.org/)
- [npm](https://www.npmjs.com/) or [yarn](https://yarnpkg.com/)
### Installation
1. Clone the repository:
```bash
git clone https://github.com/Biplo12/BoardFlow.git
```
2. Navigate to the project directory:
```bash
cd boardflow
```
3. Install dependencies:
```bash
npm install
# or
yarn install
```
## Technologies Used
- [Next.js](https://nextjs.org/) - React framework for server-rendered React applications.
- [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework.
- [TypeScript](https://www.typescriptlang.org/) - Superset of JavaScript that adds static typing.
- [Clerk](https://clerk.dev/) - Authentication and user management.
- [Convex](https://convex.dev/) - Real-time collaboration and synchronization.
- [Liveblocks](https://liveblocks.io/) - Real-time collaboration infrastructure.
## Usage
1. Run the development server:
```bash
npm run dev
# or
yarn dev
```
2. Open your browser and navigate to [http://localhost:3000](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