Virtual whiteboard for sketching hand-drawn like diagrams

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

website: https://excalidraw.com

zsviczian 332bc4d732 debounce context menu if app is resizing 6 ماه پیش
.codesandbox 50450a7dab chore: update required node version to 18 (#6837) 2 سال پیش
.github 6e0ee89ee4 fix: usage of `node12 which is deprecated` (#8791) 10 ماه پیش
.husky d0b33d35db build: temporarily disable pre-commit (#6132) 2 سال پیش
dev-docs ecef5d12f4 chore: release @excalidraw/[email protected] 🎉 (#9127) 6 ماه پیش
examples ecef5d12f4 chore: release @excalidraw/[email protected] 🎉 (#9127) 6 ماه پیش
excalidraw-app ecef5d12f4 chore: release @excalidraw/[email protected] 🎉 (#9127) 6 ماه پیش
firebase-project 7431ca81d1 fix: update `storage.rules` (#5020) 3 سال پیش
packages 332bc4d732 debounce context menu if app is resizing 6 ماه پیش
public ef9ea14a75 fix: remove manifest.json (#8783) 10 ماه پیش
scripts 70c3e921bb fix: package env vars (#9221) 6 ماه پیش
.dockerignore 8d530cf102 fix: Docker build in CI (#8312) 1 سال پیش
.editorconfig 8dccc793ee add editorconfig (#1198) 5 سال پیش
.env.development 35f778a734 build: set PWA flag in dev to false (#8788) 10 ماه پیش
.env.production df168a6883 fix: load env vars correctly and set debug and linter flags to false explicitly in prod mode (#8770) 10 ماه پیش
.eslintignore 6959a363f0 feat: canvas search (#8438) 1 سال پیش
.eslintrc.json 8551823da9 feat: update jotai (#9015) 7 ماه پیش
.gitattributes c814917927 Add gitattributes (#2164) 5 سال پیش
.gitignore ecef5d12f4 chore: release @excalidraw/[email protected] 🎉 (#9127) 6 ماه پیش
.lintstagedrc.js 5d295415db Keep errors, elements and comments consistent (#2340) 4 سال پیش
.npmrc 5b7596582f feat: color picker redesign (#6216) 2 سال پیش
.nvmrc 50450a7dab chore: update required node version to 18 (#6837) 2 سال پیش
.prettierignore 89cf826555 Change target branch of coverage and pretty print (#1850) 5 سال پیش
.watchmanconfig 24fa657093 Don't reset cache while zooming using a gesture (#1103) 5 سال پیش
CONTRIBUTING.md f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 2 سال پیش
Dockerfile 8d530cf102 fix: Docker build in CI (#8312) 1 سال پیش
LICENSE 6f33d72e35 Add MIT License (#176) 5 سال پیش
README.md ecef5d12f4 chore: release @excalidraw/[email protected] 🎉 (#9127) 6 ماه پیش
crowdin.yml d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 سال پیش
docker-compose.yml baf9da2b83 chore: Update action versions and docker build (#3065) 4 سال پیش
package.json d92384b77d revert: `vite@6` -> `vite@5` (#9220) 6 ماه پیش
setupTests.ts 4f64372506 perf: Improved pointer events related performance when the sidebar is docked with a large library open (#9086) 7 ماه پیش
tsconfig.json ecef5d12f4 chore: release @excalidraw/[email protected] 🎉 (#9127) 6 ماه پیش
vercel.json 230d0edc44 feat: multiple fonts fallbacks (#8286) 1 سال پیش
vitest.config.mts ecef5d12f4 chore: release @excalidraw/[email protected] 🎉 (#9127) 6 ماه پیش
yarn.lock d92384b77d revert: `vite@6` -> `vite@5` (#9220) 6 ماه پیش

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