Virtual whiteboard for sketching hand-drawn like diagrams
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 e93bbc5776
build: Migrate to Vite 🚀 (#6713)
* init

* add: vite dev build working

* fix: href serving from public

* feat: add ejs plugin

* feat: migrated env files and ejs templating

* chore: add types related to envs

* chore: add vite-env types

* feat: support vite pwa

* chore: upgrade vite pwa

* chore: pin node version to 16.18.1

* chore: preserve use of nodejs 14

* refactor: preserve REACT_APP as env prefix

* chore: support esm environment variables

* fix ts config

* use VITE prefix and remove vite-plugin-env-compatible

* introduce import-meta-loader for building pacakge as webpack isn't compatible with import.meta syntax

* lint

* remove import.meta.env in main.js

* set debug flag to false

* migrate to vitest and use jest-canvas-mock 2.4.0 so its comp
atible with vite

* integrate vitest-ui

* fix most of teh test

* snaps

* Add script for testing with vite ui

* fix all tests related to mocking

* fix more test

* fix more

* fix flip.test.tsx

* fix contentxmenu snaps

* fix regression snaps

* fix excalidraw.test.tsx and this makes all tests finally pass :)

* use node 16

* specify node version

* use node 16 in lint as well

* fix mobile.test.tsx

* use node 16

* add style-loader

* upgrade to node 18

* fix lint package.json

* support eslint with vite

* fix lint

* fix lint

* fix ts

* remove pwa/sw stuff

* use env vars in EJS the vite way

* fix lint

* move remainig jest mock/spy to vite

* don't cache locales

* fix regex

* add fonts cache

* tweak

* add custom service worker

* upgrade vite and create font cache again

* cache fonts.css and locales

* tweak

* use manifestTransforms for filtering locales

* use assets js pattern for locales

* add font.css to globIgnore so its pushed to fonts cache

* create a separate chunk for locales with rollup

* remove manifestTransforms and fix glob pattern for locales to filter from workbox pre-cache

* push sourcemaps in production

* add comments in config

* lint

* use node 18

* disable pwa in dev

* fix

* fix

* increase limit of bundle

* upgrade vite-pwa to latest

* remove public/workbox so workbox assets are not precached

* fon't club en.json and percentages.json with manual locales chunk to fix first load+offline mode

* tweak regex

* remove happy-dom as its not used

* add comment

* use any instead of ts-ignore

* cleanup

* remove jest-canvas-mock resolution as vite-canvas-mock was patched locking deps at 2.4.0

* use same theme color present in entry point

---------

Co-authored-by: Weslley Braga <weslley@bambee.com>
Co-authored-by: dwelle <luzar.david@gmail.com>
2 years ago
.codesandbox chore: update CodeSandbox links and add a config (#5624) 3 years ago
.github build: Migrate to Vite 🚀 (#6713) 2 years ago
.husky build: temporarily disable pre-commit (#6132) 2 years ago
dev-docs feat: introducing Web-Embeds (alias iframe element) (#6691) 2 years ago
firebase-project fix: update `storage.rules` (#5020) 3 years ago
public build: Migrate to Vite 🚀 (#6713) 2 years ago
scripts fix: use subdirectory for @excalidraw/excalidraw size limit (#6787) 2 years ago
src build: Migrate to Vite 🚀 (#6713) 2 years ago
.dockerignore build: stops ignoring .env files from docker context so env variables get set during react app build. (#5809) 2 years ago
.editorconfig add editorconfig (#1198) 5 years ago
.env.development build: Migrate to Vite 🚀 (#6713) 2 years ago
.env.production build: Migrate to Vite 🚀 (#6713) 2 years ago
.eslintignore feat: image support (#4011) 3 years ago
.eslintrc.json chore: Update Typescript to 4.4.4 (#4188) 3 years ago
.gitattributes Add gitattributes (#2164) 5 years ago
.gitignore build: Migrate to Vite 🚀 (#6713) 2 years 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 .nvmrc to match package.json engines definition (#3148) 4 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
CHANGELOG.md support embedding scene data to PNG/SVG (#2219) 5 years ago
CONTRIBUTING.md docs: migrating dev docs to docusaurus :) (#6073) 2 years ago
Dockerfile fix: docker build architecture:linux/amd64 error occur on linux/arm64 instance (#6197) 2 years ago
LICENSE Add MIT License (#176) 5 years ago
README.md docs: fix closing tag in readme (#6424 2 years ago
crowdin.yml Locale 5 years ago
docker-compose.yml chore: Update action versions and docker build (#3065) 4 years ago
index.html build: Migrate to Vite 🚀 (#6713) 2 years ago
package.json build: Migrate to Vite 🚀 (#6713) 2 years ago
tsconfig-types.json build: Migrate to Vite 🚀 (#6713) 2 years ago
tsconfig.json build: Migrate to Vite 🚀 (#6713) 2 years ago
vercel.json feat: redirect vscode.excalidraw.com to vscode marketplace (#5285) 3 years ago
vite.config.ts build: Migrate to Vite 🚀 (#6713) 2 years ago
vitest.config.ts build: Migrate to Vite 🚀 (#6713) 2 years ago
yarn.lock build: Migrate to Vite 🚀 (#6713) 2 years ago

README.md

Excalidraw

Excalidraw Editor | Blog | Documentation | Excalidraw+

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


Excalidraw is released under the MIT license. PRs welcome! Chat on Discord Follow Excalidraw on 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

Install the Excalidraw npm package:

npm install react react-dom @excalidraw/excalidraw

or via yarn

yarn add react react-dom @excalidraw/excalidraw

Don't forget to check out our Documentation!

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