Virtual whiteboard for sketching hand-drawn like diagrams

#whiteboard #app #selfhosted #docker #excel #mindmap #braindump #data #storage

website: https://excalidraw.com

dwelle 027ef1d641 build: allow node v22 1 jaar geleden
.codesandbox 50450a7dab chore: update required node version to 18 (#6837) 2 jaren geleden
.github c6fdac131b ci: add the workspace ignore check to install actions as dependency for auto release (#7593) 1 jaar geleden
.husky d0b33d35db build: temporarily disable pre-commit (#6132) 2 jaren geleden
dev-docs 275f6fbe24 fix: typo in doc api (#7466) 1 jaar geleden
examples 966f9aead9 build(deps-dev): bump vite from 5.0.6 to 5.0.12 in /examples/excalidraw/with-script-in-browser (#7603) 1 jaar geleden
excalidraw-app 1bd2b1fe55 feat: export reconciliation (#7917) 1 jaar geleden
firebase-project 7431ca81d1 fix: update `storage.rules` (#5020) 3 jaren geleden
packages d9bbf1eda6 feat: Allow binding only via linear element ends (#7946) 1 jaar geleden
public 41cc746885 fix: host font assets from root (#7548) 1 jaar geleden
scripts 99601baffc build: create ESM build for utils package 🥳 (#7500) 1 jaar geleden
.dockerignore d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 jaar geleden
.editorconfig 8dccc793ee add editorconfig (#1198) 5 jaren geleden
.env.development 4888d9d355 chore: change default port of collab server (#7641) 1 jaar geleden
.env.production d426cc968d refactor: remove portal as it is no longer needed (#7623) 1 jaar geleden
.eslintignore d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 jaar geleden
.eslintrc.json 8d4f455cd3 chore: Update Typescript to 4.4.4 (#4188) 3 jaren geleden
.gitattributes c814917927 Add gitattributes (#2164) 4 jaren geleden
.gitignore 99601baffc build: create ESM build for utils package 🥳 (#7500) 1 jaar geleden
.lintstagedrc.js 5d295415db Keep errors, elements and comments consistent (#2340) 4 jaren geleden
.npmrc 5b7596582f feat: color picker redesign (#6216) 2 jaren geleden
.nvmrc 50450a7dab chore: update required node version to 18 (#6837) 2 jaren geleden
.prettierignore 89cf826555 Change target branch of coverage and pretty print (#1850) 5 jaren geleden
.watchmanconfig 24fa657093 Don't reset cache while zooming using a gesture (#1103) 5 jaren geleden
CONTRIBUTING.md f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 2 jaren geleden
Dockerfile 5dd1efde8a build: update to node 18 in docker (#6822) 2 jaren geleden
LICENSE 6f33d72e35 Add MIT License (#176) 5 jaren geleden
README.md 537f6e7f68 docs: add steps for local development (#7449) 1 jaar geleden
crowdin.yml d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 jaar geleden
docker-compose.yml baf9da2b83 chore: Update action versions and docker build (#3065) 4 jaren geleden
package.json 027ef1d641 build: allow node v22 1 jaar geleden
setupTests.ts cd50aa719f feat: add system mode to the theme selector (#7853) 1 jaar geleden
tsconfig.json 4f0a2a9593 docs: add next js with app router example (#7552) 1 jaar geleden
vercel.json 41cc746885 fix: host font assets from root (#7548) 1 jaar geleden
vitest.config.mts d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 jaar geleden
yarn.lock f79fb9aae2 chore: Bump vitest to 1.5.3 to support VSCode vitest Extension (#7968) 1 jaar geleden

README.md


<img alt="Excalidraw is released under the MIT license." src="https://img.shields.io/badge/license-MIT-blue.svg"  />

<img alt="npm downloads/month" src="https://img.shields.io/npm/dm/@excalidraw/excalidraw"  />

<img alt="PRs welcome!" src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat"  />

<img alt="Chat on Discord" src="https://img.shields.io/discord/723672430744174682?color=738ad6&label=Chat%20on%20Discord&logo=discord&logoColor=ffffff&widge=false"/>

<img alt="Follow Excalidraw on Twitter" src="https://img.shields.io/twitter/follow/excalidraw.svg?label=follow+@excalidraw&style=social&logo=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.

npm install react react-dom @excalidraw/excalidraw

or via yarn

yarn add react react-dom @excalidraw/excalidraw

Check out our documentation for more details!

Contributing

Integrations

Who's integrating Excalidraw

Google CloudMetaCodeSandboxObsidian ExcalidrawReplitSliteNotionHackerRank • 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