Virtual whiteboard for sketching hand-drawn like diagrams

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

website: https://excalidraw.com

zsviczian e163402e22 Check for roundness undefined 1 yıl önce
.codesandbox 50450a7dab chore: update required node version to 18 (#6837) 2 yıl önce
.github c6fdac131b ci: add the workspace ignore check to install actions as dependency for auto release (#7593) 1 yıl önce
.husky d0b33d35db build: temporarily disable pre-commit (#6132) 2 yıl önce
dev-docs 275f6fbe24 fix: typo in doc api (#7466) 1 yıl önce
examples 1ed53b153c build: enable consistent type imports eslint rule (#7992) 1 yıl önce
excalidraw-app 301e83805d feat: add install-PWA to command palette (#7935) 1 yıl önce
firebase-project 7431ca81d1 fix: update `storage.rules` (#5020) 3 yıl önce
packages e163402e22 Check for roundness undefined 1 yıl önce
public 41cc746885 fix: host font assets from root (#7548) 1 yıl önce
scripts 99601baffc build: create ESM build for utils package 🥳 (#7500) 1 yıl önce
.dockerignore 6539029d2a fix: docker build of Excalidraw app (#7430) 1 yıl önce
.editorconfig 8dccc793ee add editorconfig (#1198) 5 yıl önce
.env.development 4888d9d355 chore: change default port of collab server (#7641) 1 yıl önce
.env.production d426cc968d refactor: remove portal as it is no longer needed (#7623) 1 yıl önce
.eslintignore d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 yıl önce
.eslintrc.json 1ed53b153c build: enable consistent type imports eslint rule (#7992) 1 yıl önce
.gitattributes c814917927 Add gitattributes (#2164) 4 yıl önce
.gitignore 99601baffc build: create ESM build for utils package 🥳 (#7500) 1 yıl önce
.lintstagedrc.js 5d295415db Keep errors, elements and comments consistent (#2340) 4 yıl önce
.npmrc 5b7596582f feat: color picker redesign (#6216) 2 yıl önce
.nvmrc 50450a7dab chore: update required node version to 18 (#6837) 2 yıl önce
.prettierignore 89cf826555 Change target branch of coverage and pretty print (#1850) 5 yıl önce
.watchmanconfig 24fa657093 Don't reset cache while zooming using a gesture (#1103) 5 yıl önce
CONTRIBUTING.md f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 2 yıl önce
Dockerfile 6539029d2a fix: docker build of Excalidraw app (#7430) 1 yıl önce
LICENSE 6f33d72e35 Add MIT License (#176) 5 yıl önce
README.md 537f6e7f68 docs: add steps for local development (#7449) 1 yıl önce
crowdin.yml d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 yıl önce
docker-compose.yml baf9da2b83 chore: Update action versions and docker build (#3065) 4 yıl önce
package.json cc4c51996c build: specify `packageManager` field (#8010) 1 yıl önce
setupTests.ts cd50aa719f feat: add system mode to the theme selector (#7853) 1 yıl önce
tsconfig.json 4f0a2a9593 docs: add next js with app router example (#7552) 1 yıl önce
vercel.json 41cc746885 fix: host font assets from root (#7548) 1 yıl önce
vitest.config.mts f0d25e34c3 chore: Add lcov coverage output to vitest (#7987) 1 yıl önce
yarn.lock 2f9526da24 feat: upgrade to mermaid-to-excalidraw v1 🚀 (#8022) 1 yıl önce

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