Home Explore Help
Sign In
software
/
excalidraw
mirror of https://github.com/excalidraw/excalidraw.git
2
0
Fork 0
Files Issues 0 Wiki

Virtual whiteboard for sketching hand-drawn like diagrams

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

website: https://excalidraw.com

Branch: zsviczian-fix-stuck-in-element-move
Branches Tags
excalidraw
ZIP TAR.GZ
zsviczian 11ee139d5c lint 1 year ago
.codesandbox 50450a7dab chore: update required node version to 18 (#6837) 2 years ago
.github 6ed6131169 build: run tests on master branch (#8072) 1 year ago
.husky d0b33d35db build: temporarily disable pre-commit (#6132) 2 years ago
dev-docs 63dee03ef0 docs: remove extra braces in callback JSX (#8087) 1 year ago
examples 1ed53b153c build: enable consistent type imports eslint rule (#7992) 1 year ago
excalidraw-app d2f67e619f feat: editable element stats (#6382) 1 year ago
firebase-project 7431ca81d1 fix: update `storage.rules` (#5020) 3 years ago
packages 11ee139d5c lint 1 year ago
public a71bb63d1f fix: fix twitter og image (#8050) 1 year ago
scripts 99601baffc build: create ESM build for utils package 🥳 (#7500) 1 year ago
.dockerignore 6539029d2a fix: docker build of Excalidraw app (#7430) 1 year ago
.editorconfig 8dccc793ee add editorconfig (#1198) 5 years ago
.env.development 4888d9d355 chore: change default port of collab server (#7641) 1 year ago
.env.production d426cc968d refactor: remove portal as it is no longer needed (#7623) 1 year ago
.eslintignore d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 year ago
.eslintrc.json 1ed53b153c build: enable consistent type imports eslint rule (#7992) 1 year ago
.gitattributes c814917927 Add gitattributes (#2164) 4 years ago
.gitignore 99601baffc build: create ESM build for utils package 🥳 (#7500) 1 year ago
.lintstagedrc.js 5d295415db Keep errors, elements and comments consistent (#2340) 4 years ago
.npmrc 5b7596582f feat: color picker redesign (#6216) 2 years ago
.nvmrc 50450a7dab chore: update required node version to 18 (#6837) 2 years ago
.prettierignore 89cf826555 Change target branch of coverage and pretty print (#1850) 5 years ago
.watchmanconfig 24fa657093 Don't reset cache while zooming using a gesture (#1103) 5 years ago
CONTRIBUTING.md f23cdc47ee docs: migrating dev docs to docusaurus :) (#6073) 2 years ago
Dockerfile 6539029d2a fix: docker build of Excalidraw app (#7430) 1 year ago
LICENSE 6f33d72e35 Add MIT License (#176) 5 years ago
README.md 537f6e7f68 docs: add steps for local development (#7449) 1 year ago
crowdin.yml d6cd8b78f1 build: decouple package deps and introduce yarn workspaces (#7415) 1 year ago
docker-compose.yml baf9da2b83 chore: Update action versions and docker build (#3065) 4 years ago
package.json cc4c51996c build: specify `packageManager` field (#8010) 1 year ago
setupTests.ts cd50aa719f feat: add system mode to the theme selector (#7853) 1 year ago
tsconfig.json 4f0a2a9593 docs: add next js with app router example (#7552) 1 year ago
vercel.json 41cc746885 fix: host font assets from root (#7548) 1 year ago
vitest.config.mts f0d25e34c3 chore: Add lcov coverage output to vitest (#7987) 1 year ago
yarn.lock 2f9526da24 feat: upgrade to mermaid-to-excalidraw v1 🚀 (#8022) 1 year ago

README.md 

<source media="(prefers-color-scheme: dark)" alt="Excalidraw" srcset="https://excalidraw.nyc3.cdn.digitaloceanspaces.com/github/excalidraw_github_cover_2_dark.png" />
<img alt="Excalidraw" src="https://excalidraw.nyc3.cdn.digitaloceanspaces.com/github/excalidraw_github_cover_2.png" />

Excalidraw Editor | Blog | Documentation | Excalidraw+

An open source virtual hand-drawn style whiteboard.

Collaborative and end-to-end encrypted. 


<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 Cloud • Meta • CodeSandbox • Obsidian Excalidraw • Replit • Slite • Notion • HackerRank • 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