Virtual whiteboard for sketching hand-drawn like diagrams

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

website: https://excalidraw.com

Aakansha Doshi ef9ea14a75 fix: remove manifest.json (#8783) 8 ヶ月 前
.codesandbox 50450a7dab chore: update required node version to 18 (#6837) 2 年 前
.github 33b01d4e80 fix: usage of `node12 which is deprecated` (#8709) 9 ヶ月 前
.husky d0b33d35db build: temporarily disable pre-commit (#6132) 2 年 前
dev-docs b479f3bd65 feat: add first-class support for CJK (#8530) 9 ヶ月 前
examples 61623bbeba fix: Comic Shanns issues, new fonts structure (#8641) 9 ヶ月 前
excalidraw-app df168a6883 fix: load env vars correctly and set debug and linter flags to false explicitly in prod mode (#8770) 8 ヶ月 前
firebase-project 7431ca81d1 fix: update `storage.rules` (#5020) 3 年 前
packages 798f5f4dfb feat: update blog url (#8767) 8 ヶ月 前
public ef9ea14a75 fix: remove manifest.json (#8783) 8 ヶ月 前
scripts 61623bbeba fix: Comic Shanns issues, new fonts structure (#8641) 9 ヶ月 前
.dockerignore 8d530cf102 fix: Docker build in CI (#8312) 11 ヶ月 前
.editorconfig 8dccc793ee add editorconfig (#1198) 5 年 前
.env.development d9ad7c039b feat: export scene to e+ on workspace creation/redemption (#8514) 8 ヶ月 前
.env.production df168a6883 fix: load env vars correctly and set debug and linter flags to false explicitly in prod mode (#8770) 8 ヶ月 前
.eslintignore 6959a363f0 feat: canvas search (#8438) 10 ヶ月 前
.eslintrc.json 1ed53b153c build: enable consistent type imports eslint rule (#7992) 1 年間 前
.gitattributes c814917927 Add gitattributes (#2164) 4 年 前
.gitignore 99601baffc build: create ESM build for utils package 🥳 (#7500) 1 年間 前
.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) 11 ヶ月 前
LICENSE 6f33d72e35 Add MIT License (#176) 5 年 前
README.md 537f6e7f68 docs: add steps for local development (#7449) 1 年間 前
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 da33481fa3 chore: support upto node 22.x.x (#8755) 8 ヶ月 前
setupTests.ts e957c8e9ee feat: image cropping (#8613) 9 ヶ月 前
tsconfig.json 4f0a2a9593 docs: add next js with app router example (#7552) 1 年間 前
vercel.json 230d0edc44 feat: multiple fonts fallbacks (#8286) 1 年間 前
vitest.config.mts a80cb5896a feat: self-hosting existing google fonts (#8540) 10 ヶ月 前
yarn.lock 7d52176fea feat: added sitemap & fixed robot txt (#8699) 9 ヶ月 前

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