Virtual whiteboard for sketching hand-drawn like diagrams

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

website: https://excalidraw.com

zsviczian 17477480f3 check for strict null 11 miesięcy temu
.codesandbox 50450a7dab chore: update required node version to 18 (#6837) 2 lat temu
.github 232242d2e9 test: skip test.yml in PRs (#8330) 11 miesięcy temu
.husky d0b33d35db build: temporarily disable pre-commit (#6132) 2 lat temu
dev-docs a6684b09f2 docs: fix typos in props.mdx (#8325) 11 miesięcy temu
examples c641860cb1 fix: CVE-2023-45133 (#7988) 11 miesięcy temu
excalidraw-app f19ce30dfe chore: bump `@testing-library/react` `12.1.5` -> `16.0.0` (#8322) 11 miesięcy temu
firebase-project 7431ca81d1 fix: update `storage.rules` (#5020) 3 lat temu
packages 17477480f3 check for strict null 11 miesięcy temu
public 62228e0bbb feat: introduce font picker (#8012) 1 rok temu
scripts 8d530cf102 fix: Docker build in CI (#8312) 11 miesięcy temu
.dockerignore 8d530cf102 fix: Docker build in CI (#8312) 11 miesięcy temu
.editorconfig 8dccc793ee add editorconfig (#1198) 5 lat temu
.env.development e52c2cd0b6 fix: log allowed events (#8224) 1 rok temu
.env.production 6fbc44fd1f fix: messed up env variable (#8231) 1 rok temu
.eslintignore b87925d253 build: add example apps `public` and vite `dev-dist` to eslintignore (#8326) 11 miesięcy temu
.eslintrc.json 1ed53b153c build: enable consistent type imports eslint rule (#7992) 1 rok temu
.gitattributes c814917927 Add gitattributes (#2164) 4 lat temu
.gitignore 99601baffc build: create ESM build for utils package 🥳 (#7500) 1 rok temu
.lintstagedrc.js 5d295415db Keep errors, elements and comments consistent (#2340) 4 lat temu
.npmrc 5b7596582f feat: color picker redesign (#6216) 2 lat temu
.nvmrc 50450a7dab chore: update required node version to 18 (#6837) 2 lat temu
.prettierignore 89cf826555 Change target branch of coverage and pretty print (#1850) 5 lat temu
.watchmanconfig 24fa657093 Don't reset cache while zooming using a gesture (#1103) 5 lat temu
CONTRIBUTING.md f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 2 lat temu
Dockerfile 8d530cf102 fix: Docker build in CI (#8312) 11 miesięcy temu
LICENSE 6f33d72e35 Add MIT License (#176) 5 lat temu
README.md 537f6e7f68 docs: add steps for local development (#7449) 1 rok temu
crowdin.yml d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 rok temu
docker-compose.yml baf9da2b83 chore: Update action versions and docker build (#3065) 4 lat temu
package.json b427617f66 build: add `rm:build`, `rm:node_modules` & `clean-install` scripts (#8323) 11 miesięcy temu
setupTests.ts 1ea5b26f25 fix: missing `act()` in flowchart tests (#8354) 11 miesięcy temu
tsconfig.json 4f0a2a9593 docs: add next js with app router example (#7552) 1 rok temu
vercel.json 230d0edc44 feat: multiple fonts fallbacks (#8286) 1 rok temu
vitest.config.mts 8d530cf102 fix: Docker build in CI (#8312) 11 miesięcy temu
yarn.lock f19ce30dfe chore: bump `@testing-library/react` `12.1.5` -> `16.0.0` (#8322) 11 miesięcy temu

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