excalidraw/README.md

60 lines
1.8 KiB
Markdown
Raw Normal View History

2020-01-04 16:25:10 +01:00
<div align="center" style="display:flex;flex-direction:column;">
<a href="https://excalidraw.com">
<img src=".github/assets/logo.png" alt="" width="220px" height="202"/>
</a>
<h3>Excalidraw is a whiteboard tool that lets you easily sketch diagrams that have a hand-drawn feel to them.</h3>
</div>
2020-01-04 00:29:13 +01:00
## Try it now
2020-01-04 03:19:58 +01:00
Go to https://excalidraw.com to start sketching
2020-01-04 00:29:13 +01:00
## Testimonials
2020-01-05 19:09:36 +01:00
<a href="https://twitter.com/Lissy_Sykes/status/1213813117177729026"><img width="398" src="https://user-images.githubusercontent.com/197597/71783813-dbf8a600-2fa0-11ea-9c0d-bb3cc45969e6.png"></a>
<a href="https://twitter.com/dan_abramov/status/1213762494428262400"><img width="398" src="https://user-images.githubusercontent.com/197597/71783990-4d395880-2fa3-11ea-9ad7-186138db5003.png"></a>
## Run the code
2020-01-04 00:29:13 +01:00
2020-01-04 03:19:58 +01:00
### Code Sandbox
2020-01-04 00:29:13 +01:00
2020-01-04 03:19:58 +01:00
- Go to https://codesandbox.io/s/github/excalidraw/excalidraw
- You can start coding instantly, and even send PRs from there!
2020-01-04 00:29:13 +01:00
2020-01-04 03:19:58 +01:00
### Local Installation
2020-01-04 00:29:13 +01:00
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.
Clone the repo
```bash
2020-01-04 03:19:58 +01:00
git clone https://github.com/excalidraw/excalidraw.git
2020-01-04 00:29:13 +01:00
```
Install all the dependencies
```bash
npm install
```
Run the project
```bash
npm run start
```
## Contributing
Pull requests are welcome. For major changes, please open an [issue](https://github.com/excalidraw/excalidraw/issues) first to discuss what you would like to change.
2020-01-04 03:19:58 +01:00
2020-01-05 18:51:53 +01:00
You can also discuss the app on our [Gitter channel](https://gitter.im/excalidraw/community).
2020-01-04 03:19:58 +01:00
## Excalidraw is built using these awesome tools
- [React](https://reactjs.org/)
- [Rough.js](https://roughjs.com/)
And the main source of inspiration for starting the project is the awesome [Zwibbler](https://zwibbler.com/demo/) app.