An open source virtual hand-drawn style whiteboard.
Collaborative and end-to-end encrypted.
Create beautiful hand-drawn like diagrams, wireframes, or whatever you like.
## Features
The Excalidraw editor (npm package) supports:
- 💯 Free & open-source.
- 🎨 Infinite, canvas-based whiteboard.
- ✍️ Hand-drawn like style.
- 🌓 Dark mode.
- 🏗️ Customizable.
- 📷 Image support.
- 😀 Shape libraries support.
- 👅 Localization (i18n) support.
- 🖼️ Export to PNG, SVG & clipboard.
- 💾 Open format - export drawings as an `.excalidraw` json file.
- ⚒️ Wide range of tools - rectangle, circle, diamond, arrow, line, free-draw, eraser...
- ➡️ Arrow-binding & labeled arrows.
- 🔙 Undo / Redo.
- 🔍 Zoom and panning support.
## Excalidraw.com
The app hosted at [excalidraw.com](https://excalidraw.com) is a minimal showcase of what you can build with Excalidraw. Its [source code](https://github.com/excalidraw/excalidraw/tree/master/excalidraw-app) is part of this repository as well, and the app features:
- 📡 PWA support (works offline).
- 🤼 Real-time collaboration.
- 🔒 End-to-end encryption.
- 💾 Local-first support (autosaves to the browser).
- 🔗 Shareable links (export to a readonly link you can share with others).
We'll be adding these features as drop-in plugins for the npm package in the future.
## Quick start
**Note:** following instructions are for installing the Excalidraw [npm package](https://www.npmjs.com/package/@excalidraw/excalidraw) when integrating Excalidraw into your own app. To run the repository locally for development, please refer to our [Development Guide](https://docs.excalidraw.com/docs/introduction/development).
Use `npm` or `yarn` to install the package.
```bash
npm install react react-dom @excalidraw/excalidraw
# or
yarn add react react-dom @excalidraw/excalidraw
```
Check out our [documentation](https://docs.excalidraw.com/docs/@excalidraw/excalidraw/installation) for more details!
## Deploy on Minikube
- 1. ```git clone git@github.com:rescenic/excalidraw.git```
- 2. ```cd excalidraw```
- 3. ```docker build -t excalidraw:v1.0.0 .```
- 4. ```minikube image load excalidraw:v1.0.0```
- 5. ```minikube image ls```
- 6. ```minikube addons enable ingress```
- 7. Add rescenic.com to system hosts:
```host
127.0.0.1 rescenic.com
::1 rescenic.com
```
- 8. ```kubectl apply -f deployment.yaml```
- 9. Check service in the pod:
```zsh
kubectl get pod
NAME READY STATUS RESTARTS AGE
excalidraw-7f4cbc69b4-dqkbt 1/1 Running 0 17m
kubectl exec -it excalidraw-7f4cbc69b4-dqkbt -- /bin/sh
/ # curl localhost
/ # exit
```
- 10. ```kubectl port-forward svc/excalidraw-service 9991:80```
- 11. ```minikube tunnel```
- 12. Check in host browser: http://rescenic.com
## Contributing
- Missing something or found a bug? [Report here](https://github.com/excalidraw/excalidraw/issues).
- Want to contribute? Check out our [contribution guide](https://docs.excalidraw.com/docs/introduction/contributing) or let us know on [Discord](https://discord.gg/UexuTaE).
- Want to help with translations? See the [translation guide](https://docs.excalidraw.com/docs/introduction/contributing#translating).
## Integrations
- [VScode extension](https://marketplace.visualstudio.com/items?itemName=pomdtr.excalidraw-editor)
- [npm package](https://www.npmjs.com/package/@excalidraw/excalidraw)
## Who's integrating Excalidraw
[Google Cloud](https://googlecloudcheatsheet.withgoogle.com/architecture) • [Meta](https://meta.com/) • [CodeSandbox](https://codesandbox.io/) • [Obsidian Excalidraw](https://github.com/zsviczian/obsidian-excalidraw-plugin) • [Replit](https://replit.com/) • [Slite](https://slite.com/) • [Notion](https://notion.so/) • [HackerRank](https://www.hackerrank.com/) • and many others
## Sponsors & support
If you like the project, you can become a sponsor at [Open Collective](https://opencollective.com/excalidraw) or use [Excalidraw+](https://plus.excalidraw.com/).
## Thank you for supporting Excalidraw
[](https://opencollective.com/excalidraw/tiers/sponsors/0/website) [](https://opencollective.com/excalidraw/tiers/sponsors/1/website) [](https://opencollective.com/excalidraw/tiers/sponsors/2/website) [](https://opencollective.com/excalidraw/tiers/sponsors/3/website) [](https://opencollective.com/excalidraw/tiers/sponsors/4/website) [](https://opencollective.com/excalidraw/tiers/sponsors/5/website) [](https://opencollective.com/excalidraw/tiers/sponsors/6/website) [](https://opencollective.com/excalidraw/tiers/sponsors/7/website) [](https://opencollective.com/excalidraw/tiers/sponsors/8/website) [](https://opencollective.com/excalidraw/tiers/sponsors/9/website) [](https://opencollective.com/excalidraw/tiers/sponsors/10/website)
Last but not least, we're thankful to these companies for offering their services for free:
[](https://vercel.com) [](https://sentry.io) [](https://crowdin.com)
](https://opencollective.com/excalidraw/tiers/sponsors/0/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/1/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/2/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/3/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/4/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/5/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/6/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/7/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/8/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/9/website) [
](https://opencollective.com/excalidraw/tiers/sponsors/10/website)
Last but not least, we're thankful to these companies for offering their services for free:
[](https://vercel.com) [](https://sentry.io) [](https://crowdin.com)