Skip to content

About

Virtual whiteboard for sketching hand-drawn like diagrams

Resources

Contributing

Stars

54 stars

Watchers

2 watching

Forks

 
 

Latest commit

 

History

4,140 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Excalidraw without firebase

This is a fork from the excalidraw project with changes inspired and partly taken from Kilian Decaderincourt to enable support for rooms without using firebase.

Setup with docker

Please copy the .env.default file to .env and change it according to your needs.

Development

Execute

docker compose up --build -d
docker compose exec -it excalidraw /bin/bash

or if you have yarn available on your host you also can simply run

yarn docker:dev:up

This will start all docker containers and connects you to the main app container with all your code files mounted. Inside that container run

yarn install
yarn start --host

This will start excalidraw on your configured VITE_APP_PORT (default 3000).

If you prefer to have your dev server running on your host, you can use yarn docker:services:up and run the yarn commands directly on your host.

To shut down all docker containers simply run yarn docker:dev:down (yarn docker:services:down respectively) on your host.

Hint: Collab mode requires a secure context (https). Localhost works as well, but not http over local network.

Commands

Command Description
yarn Install the dependencies
yarn start Run the project
yarn fix Reformat all files with Prettier
yarn test Run tests
yarn test:update Update test snapshots
yarn test:code Test for formatting with Prettier

Production

Note: The default port of nginx changed from 80 to 8080.

docker compose -f docker-compose-prod.yml up --build -d

or if you have yarn available on your host you also can simply run

yarn docker:prod:up

(this additionally loads .env.production.local, see hint below)

This will start excalidraw on your configured PROD_APP_PORT (default 5010).

Hint: If you want to override things in comparison to your dev environment, just create .env.production.local and define changed variables.

README from upstream

Excalidraw

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


Excalidraw is released under the MIT license. npm downloads/month PRs welcome! Chat on Discord Ask DeepWiki 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

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.

Use npm or yarn to install the package.

npm install react react-dom @excalidraw/excalidraw
# or
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

About

Virtual whiteboard for sketching hand-drawn like diagrams

Resources

Contributing

Stars

54 stars

Watchers

2 watching

Forks

Releases

Packages

Contributors

Languages