27manavgandhi / board-wex

A collaborative, real-time whiteboard. Packed with features such as real-time database, whiteboard from scratch with ability to add shapes like Rectangles and Ellipses, Sticky notes and Pencil drawing. Using the newest technologies such as Next.js. 14, Clerk, Convex and LiveBlocks.

Board Wex

Welcome to Board Wex - A collaborative, real-time whiteboard application. This project is packed with features to enhance your productivity and creativity in a real-time collaborative environment. Built using the newest technologies such as Next.js 14, Clerk, Convex, and LiveBlocks.

Features

• 🛠️ Whiteboard from scratch: Create a whiteboard from the ground up.
• 🧰 Toolbar with Text, Shapes, Sticky Notes & Pencil: Easily add text, draw shapes like Rectangles and Ellipses, add sticky notes, and draw freely with the pencil tool.
• 🪄 Layering functionality: Organize your drawings and notes with layering.
• 🎨 Coloring system: Customize the colors of your drawings and notes.
• ↩️ Undo & Redo functionality: Effortlessly correct mistakes with undo and redo actions.
• ⌨️ Keyboard shortcuts: Improve your efficiency with keyboard shortcuts.
• 🤝 Real-time collaboration: Work with others in real-time on the same whiteboard.
• 💾 Real-time database: Your changes are instantly saved and synchronized.
• 🔐 Auth, organizations, and invites: Secure authentication, manage organizations, and invite collaborators.
• ⭐️ Favoriting functionality: Mark and manage your favorite whiteboards.
• 🌐 Next.js 14 framework: Built with the latest version of Next.js for a robust and scalable application.
• 💅 TailwindCSS & ShadcnUI styling: Stylish and responsive design using TailwindCSS and ShadcnUI.

ScreenShot

Getting Started

To get started with Board Wex, follow these steps:

1. Clone the repository:

   git clone https://github.com/yourusername/board-wex.git
   cd board-wex

2. Install dependencies:

   npm install

3. Set up environment variables:

   Create a .env.local file in the root of the project and add your environment variables.

4. Run the development server:

   npm run dev

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

Contributing

We welcome contributions to Board Wex! Please follow these steps to contribute:

1. Fork the repository.
2. Create a new branch: git checkout -b feature/your-feature-name.
3. Make your changes.
4. Commit your changes: git commit -m 'Add some feature'.
5. Push to the branch: git push origin feature/your-feature-name.
6. Open a pull request.

License

This project is licensed under the MIT License.

Contact

If you have any questions or suggestions, feel free to reach out to us!

• Email: [email protected]
• GitHub Issues: Create an issue

---

Thank you for using Board Wex! Happy collaborating!