Skip to content

Commit

Permalink
Add basic README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ggenzone committed Dec 9, 2023
1 parent 0525303 commit d873382
Show file tree
Hide file tree
Showing 3 changed files with 51 additions and 1 deletion.
Empty file added CONTRIBUTING.md
Empty file.
50 changes: 50 additions & 0 deletions README.md
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).
2 changes: 1 addition & 1 deletion src/features/app/routes.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export function ErrorPage (): JSX.Element {

export const routes = createBrowserRouter([
{
path: isDevMode ? '/bristles' : '/',
path: isDevMode ? '/bristles' : '/bristles',
errorElement: <ErrorPage />,
element: <AppLayout />,
children: [{
Expand Down

0 comments on commit d873382

Please sign in to comment.