Excalidraw is a whiteboard tool that lets you easily sketch diagrams with a hand-drawn feel.
## Run the code
### Code Sandbox
- Go to https://codesandbox.io/s/github/excalidraw/excalidraw
- You can start coding instantly, and even send PRs from there!
### Local Installation
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
git clone https://github.com/excalidraw/excalidraw.git
```
#### Commands
| Command | Description |
| ------------------- | --------------------------------- |
| `npm install` | Install the dependencies |
| `npm start` | Run the project |
| `npm run fix` | Reformat all files with Prettier |
| `npm run test:code` | Test for formatting with Prettier |
| `npm run test:app` | Test the app |
| `npm run test` | Run all tests |
## Contributing
Pull requests are welcome. For major changes, please [open an issue](https://github.com/excalidraw/excalidraw/issues/new) first to discuss what you would like to change.
To translate Excalidraw into other languages, please visit [our Crowdin page](https://crowdin.com/project/excalidraw). To add a new language, open an issue so we can get things set up on our end first.
You can also discuss the app on our [Gitter channel](https://gitter.im/excalidraw/community).
## Excalidraw is built using these awesome tools
- [React](https://reactjs.org)
- [Rough.js](https://roughjs.com)
- [TypeScript](https://typescriptlang.org)
- [ZEIT Now](https://zeit.co)
And the main source of inspiration for starting the project is the awesome [Zwibbler](https://zwibbler.com/demo/) app.
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/excalidraw/contribute)]
#### Individuals
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/excalidraw/contribute)]
