taronvardanyan / boardy

Project for creating and managing real-time organization-based boards.

Boardy

Boardy is a project aimed at creating a collaborative whiteboard tool similar to Miro. It leverages modern web technologies to offer a reliable platform for real-time collaboration and content creation.

Features

• Authentication: Integrate robust authentication with @clerk/nextjs.
• Real-time Collaboration: Implement real-time features with @liveblocks/client, @liveblocks/node, and @liveblocks/react.
• UI Components: Access a collection of UI components from Radix UI for building modern interfaces.
• State Management: Utilize zustand for state management.
• Styling: Use Tailwind CSS and related plugins for styling and animations.
• Type Safety: Ensure type safety with TypeScript.

Getting Started

1. Installation: Clone the repository and install dependencies.

git clone https://github.com/TaronVardanyan/boardy.git
cd boardy
bun install

2. Development: Start the development server.

bun dev

3. Building: Build the project for production.

bun build

4. Start: Start the production server.

bun start

5. Lint: Lint the codebase.

bun lint

6. Format: Check the codebase formatting.

bun format

7. Format Fix: Fix the codebase formatting.

bun format:fix

Scripts

• dev: Start the development server using Next.js.
• build: Build the project using Next.js for production.
• start: Start the production server using Next.js.
• lint: Lint the codebase using ESLint.
• format: Check the codebase formatting using Prettier.
• format:fix: Fix the codebase formatting using Prettier.

Contributing

We welcome contributions to Boardy! To contribute:

1. Fork the repository.
2. Create a new branch (git checkout -b feature/my-feature).
3. Commit your changes (git commit -am 'Add new feature').
4. Push to the branch (git push origin feature/my-feature).
5. Create a new Pull Request.

License

This project is licensed under the MIT License.