success

Virtual whiteboard for sketching hand-drawn like diagrams

canvas collaboration diagrams drawing hacktoberfest productivity whiteboard

You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

Go to file

Aakansha Doshi 0c3dffb082 fix: make getEmbedLink independent of t function (#7643 ) * fix: make getEmbedLink independent of t function * rename warning to error and make it type safe		1 year ago
.codesandbox	chore: update required node version to 18 (#6837 )	2 years ago
.github	ci: add the workspace ignore check to install actions as dependency for auto release (#7593 )	1 year ago
.husky	build: temporarily disable pre-commit (#6132 )	2 years ago
dev-docs	docs: update the docs for next js integration (#7605 )	1 year ago
examples/excalidraw	build(deps-dev): bump vite from 5.0.6 to 5.0.12 in /examples/excalidraw/with-script-in-browser (#7603 )	1 year ago
excalidraw-app	refactor: remove portal as it is no longer needed (#7623 )	1 year ago
firebase-project	fix: update `storage.rules` (#5020 )	3 years ago
packages	fix: make getEmbedLink independent of t function (#7643 )	1 year ago
public	fix: host font assets from root (#7548 )	1 year ago
scripts	docs: add next js with app router example (#7552 )	1 year ago
.dockerignore	build: decouple package deps and introduce yarn workspaces (#7415 )	1 year ago
.editorconfig	add editorconfig (#1198 )	5 years ago
.env.development	chore: change default port of collab server (#7641 )	1 year ago
.env.production	refactor: remove portal as it is no longer needed (#7623 )	1 year ago
.eslintignore	build: decouple package deps and introduce yarn workspaces (#7415 )	1 year ago
.eslintrc.json	chore: Update Typescript to 4.4.4 (#4188 )	3 years ago
.gitattributes	Add gitattributes (#2164 )	4 years ago
.gitignore	docs: add next js with app router example (#7552 )	1 year ago
.lintstagedrc.js	Keep errors, elements and comments consistent (#2340 )	4 years ago
.npmrc	feat: color picker redesign (#6216 )	2 years ago
.nvmrc	chore: update required node version to 18 (#6837 )	2 years ago
.prettierignore	Change target branch of coverage and pretty print (#1850 )	5 years ago
.watchmanconfig	Don't reset cache while zooming using a gesture (#1103 )	5 years ago
CONTRIBUTING.md	docs: migrating dev docs to docusaurus :) (#6073 )	2 years ago
Dockerfile	build: update to node 18 in docker (#6822 )	2 years ago
LICENSE	Add MIT License (#176 )	5 years ago
README.md	docs: add steps for local development (#7449 )	1 year ago
crowdin.yml	build: decouple package deps and introduce yarn workspaces (#7415 )	1 year ago
docker-compose.yml	chore: Update action versions and docker build (#3065 )	4 years ago
package.json	build(deps-dev): bump vite from 5.0.6 to 5.0.12 (#7586 )	1 year ago
setupTests.ts	build: decouple package deps and introduce yarn workspaces (#7415 )	1 year ago
tsconfig.json	docs: add next js with app router example (#7552 )	1 year ago
vercel.json	fix: host font assets from root (#7548 )	1 year ago
vitest.config.mts	build: decouple package deps and introduce yarn workspaces (#7415 )	1 year ago
yarn.lock	build(deps-dev): bump vite from 5.0.6 to 5.0.12 (#7586 )	1 year ago

README.md

Excalidraw Editor | Blog | Documentation | Excalidraw+

An open source virtual hand-drawn style whiteboard.
Collaborative and end-to-end encrypted.

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

Missing something or found a bug? Report here.
Want to contribute? Check out our contribution guide or let us know on Discord.
Want to help with translations? See the translation guide.

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: