-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
51 additions
and
1 deletion.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
# 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: | ||
|
||
```bash | ||
git clone https://github.com/bristles-xyz/bristles.git | ||
``` | ||
|
||
2. Install dependencies: | ||
|
||
```bash | ||
cd bristles | ||
npm install | ||
``` | ||
|
||
3. Start the development server: | ||
|
||
```bash | ||
npm run start | ||
``` | ||
|
||
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](CONTRIBUTING.md). | ||
|
||
## Acknowledgements | ||
|
||
This project was inspired by [Excalidraw](https://excalidraw.com/) and [tldraw](https://tldraw.com/), which are both powerful canvas apps that serve as great examples of collaborative drawing applications. | ||
|
||
Special thanks to [Redhwan Nacef](https://www.youtube.com/@RedhwanNacef) 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](LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters