Virtual whiteboard for sketching hand-drawn like diagrams

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

website: https://excalidraw.com

Narek Malkhasyan e058a08b33 fix: use rimraf instead of rm -rf (#9460) hace 2 meses
.codesandbox 50450a7dab chore: update required node version to 18 (#6837) hace 2 años
.github 6e0ee89ee4 fix: usage of `node12 which is deprecated` (#8791) hace 8 meses
.husky d0b33d35db build: temporarily disable pre-commit (#6132) hace 2 años
dev-docs debf2ad608 docs: Fix missing verb in Footer component documentation (#9393) hace 3 meses
examples 5fc13e4309 feat: add `props.renderScrollbars` (#9399) hace 3 meses
excalidraw-app 3dc54a724a feat: add `onIncrement` API (#9450) hace 2 meses
firebase-project 7431ca81d1 fix: update `storage.rules` (#5020) hace 3 años
packages e058a08b33 fix: use rimraf instead of rm -rf (#9460) hace 2 meses
public ef9ea14a75 fix: remove manifest.json (#8783) hace 8 meses
scripts 432a46ef9e refactor: separate elements logic into a standalone package (#9285) hace 4 meses
.dockerignore 8d530cf102 fix: Docker build in CI (#8312) hace 11 meses
.editorconfig 8dccc793ee add editorconfig (#1198) hace 5 años
.env.development f2e8404c7b feat: allow to disable preventUnload in dev (#9319) hace 3 meses
.env.production df168a6883 fix: load env vars correctly and set debug and linter flags to false explicitly in prod mode (#8770) hace 8 meses
.eslintignore 6959a363f0 feat: canvas search (#8438) hace 10 meses
.eslintrc.json 4a60fe3d22 fix: remove `noreferrer` on internal links (#9452) hace 2 meses
.gitattributes c814917927 Add gitattributes (#2164) hace 4 años
.gitignore ecef5d12f4 chore: release @excalidraw/[email protected] 🎉 (#9127) hace 4 meses
.lintstagedrc.js 5d295415db Keep errors, elements and comments consistent (#2340) hace 4 años
.npmrc 5b7596582f feat: color picker redesign (#6216) hace 2 años
.nvmrc 50450a7dab chore: update required node version to 18 (#6837) hace 2 años
.prettierignore 89cf826555 Change target branch of coverage and pretty print (#1850) hace 5 años
.watchmanconfig 24fa657093 Don't reset cache while zooming using a gesture (#1103) hace 5 años
CONTRIBUTING.md f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) hace 2 años
Dockerfile 8d530cf102 fix: Docker build in CI (#8312) hace 11 meses
LICENSE 6f33d72e35 Add MIT License (#176) hace 5 años
README.md ecef5d12f4 chore: release @excalidraw/[email protected] 🎉 (#9127) hace 4 meses
crowdin.yml d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) hace 1 año
docker-compose.yml baf9da2b83 chore: Update action versions and docker build (#3065) hace 4 años
package.json e058a08b33 fix: use rimraf instead of rm -rf (#9460) hace 2 meses
setupTests.ts b5d60973b7 fix: duplication tests pointer state leaking between tests (#9414) hace 3 meses
tsconfig.json 432a46ef9e refactor: separate elements logic into a standalone package (#9285) hace 4 meses
vercel.json 230d0edc44 feat: multiple fonts fallbacks (#8286) hace 1 año
vitest.config.mts 432a46ef9e refactor: separate elements logic into a standalone package (#9285) hace 4 meses
yarn.lock e058a08b33 fix: use rimraf instead of rm -rf (#9460) hace 2 meses

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.

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!

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