smig/excalidraw
1
0
Fork 0
mirror of https://github.com/excalidraw/excalidraw.git synced 2025-04-14 16:40:58 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
excalidraw/README.md
Muhammad Ridwan Hakim, S.T., CPITA, ITPMCP c9a4b73158
Merge d3816ef5bd into dff69e9191
2025-04-10 11:52:47 +07:00

8.3 KiB
Raw Blame History

Excalidraw

Excalidraw Editor | Blog | Documentation | Excalidraw+

An open source virtual hand-drawn style whiteboard.
Collaborative and end-to-end encrypted.


Excalidraw is released under the MIT license. npm downloads/month PRs welcome! Chat on Discord Follow Excalidraw on Twitter

Product showcase

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 is a minimal showcase of what you can build with Excalidraw. Its source code 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 when integrating Excalidraw into your own app. To run the repository locally for development, please refer to our Development Guide.

Use npm or yarn to install the package.

npm install react react-dom @excalidraw/excalidraw
# or
yarn add react react-dom @excalidraw/excalidraw

Check out our documentation for more details!

Deploy on Minikube

    1. git clone git@github.com:rescenic/excalidraw.git
    1. cd excalidraw
    1. docker build -t excalidraw:v1.0.0 .
    1. minikube image load excalidraw:v1.0.0
    1. minikube image ls
    1. minikube addons enable ingress
    1. Add rescenic.com to system hosts:
127.0.0.1 rescenic.com
::1 rescenic.com
    1. kubectl apply -f deployment.yaml
    1. Check service in the pod:
 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
    1. kubectl port-forward svc/excalidraw-service 9991:80
    1. minikube tunnel
    1. Check in host browser: http://rescenic.com

Contributing

Integrations

Who's integrating Excalidraw

Google Cloud • Meta • CodeSandbox • Obsidian Excalidraw • Replit • Slite • Notion • HackerRank • and many others

Sponsors & support

If you like the project, you can become a sponsor at Open Collective or use Excalidraw+.

Thank you for supporting Excalidraw

Last but not least, we're thankful to these companies for offering their services for free:

Vercel Sentry Crowdin