From d87338249488cdfb2a7ac222237d573241acffc7 Mon Sep 17 00:00:00 2001 From: Guido Genzone Date: Sat, 9 Dec 2023 12:35:05 +0100 Subject: [PATCH] Add basic README.md --- CONTRIBUTING.md | 0 README.md | 50 +++++++++++++++++++++++++++++++++++++ src/features/app/routes.tsx | 2 +- 3 files changed, 51 insertions(+), 1 deletion(-) create mode 100644 CONTRIBUTING.md create mode 100644 README.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..e69de29 diff --git a/README.md b/README.md new file mode 100644 index 0000000..33db9db --- /dev/null +++ b/README.md @@ -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). diff --git a/src/features/app/routes.tsx b/src/features/app/routes.tsx index 59abda1..d0c7c9a 100644 --- a/src/features/app/routes.tsx +++ b/src/features/app/routes.tsx @@ -23,7 +23,7 @@ export function ErrorPage (): JSX.Element { export const routes = createBrowserRouter([ { - path: isDevMode ? '/bristles' : '/', + path: isDevMode ? '/bristles' : '/bristles', errorElement: , element: , children: [{