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.
- 🛠️ 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.
To get started with Board Wex, follow these steps:
-
Clone the repository:
git clone https://github.com/yourusername/board-wex.git cd board-wex -
Install dependencies:
npm install
-
Set up environment variables:
Create a
.env.localfile in the root of the project and add your environment variables. -
Run the development server:
npm run dev
Open http://localhost:3000 with your browser to see the result.
We welcome contributions to Board Wex! Please follow these steps to contribute:
- Fork the repository.
- Create a new branch:
git checkout -b feature/your-feature-name. - Make your changes.
- Commit your changes:
git commit -m 'Add some feature'. - Push to the branch:
git push origin feature/your-feature-name. - Open a pull request.
This project is licensed under the MIT License.
If you have any questions or suggestions, feel free to reach out to us!
- Email: 27manavgandhi@gmail.com
- GitHub Issues: Create an issue
Thank you for using Board Wex! Happy collaborating!