Skip to content

bristles-xyz/bristles

Repository files navigation

Bristles

This project is an open-source online collaborative drawing app built using React, TypeScript, and Canvas. The goal is to provide users with a platform where they can draw together in real-time over encrypted communication.

Features

  • Real-time collaboration: Multiple users can draw together simultaneously.
  • Encrypted communication: Ensuring privacy and security during collaborative sessions.
  • Drawing tools: Various tools for drawing shapes, lines, colors, and more.
  • Responsive design: Works well on different devices and screen sizes.

Getting Started

To get started with this project, follow these steps:

  1. Clone the repository:

    git clone https://github.com/bristles-xyz/bristles.git
  2. Install dependencies:

    cd bristles
    npm install
  3. Start the development server:

    turbo dev
  4. Open your web browser and navigate to http://localhost:5173 to see the app running.

Contributing

Contributions are welcome! If you'd like to contribute to this project, feel free to open an issue or submit a pull request. Make sure to follow the Contributing Guidelines.

Acknowledgements

This project was inspired by Excalidraw and tldraw, which are both powerful canvas apps that serve as great examples of collaborative drawing applications.

Special thanks to Redhwan Nacef whose videos on YouTube provided valuable guidance and tutorials, helping me get started with this project.

License

This project is licensed under the MIT License.

About

Create diagrams, sketches, and illustrations using a simple canvas-based drawing tool.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published