excalidraw

Virtual whiteboard for sketching hand-drawn like diagrams.

Try it now

Go to excalidraw.com to start sketching.

Read our blog and follow the guides to learn more about Excalidraw and how to use it effectively.

Shape libraries

Find a growing list of libraries containing assets for your drawings at libraries.excalidraw.com.

Run the code

Code Sandbox

• Go to https://codesandbox.io/s/github/excalidraw/excalidraw
  • You may need to sign in with Github and reload the page
• You can start coding instantly, and even send PRs from there!

Local Installation

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

Clone the repo

git clone https://github.com/excalidraw/excalidraw.git

Commands

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

Docker Compose

You can use docker-compose to work on excalidraw locally if you don't want to setup a Node.js env.

docker-compose up --build -d

Self hosting

We publish a Docker image with the Excalidraw client at excalidraw/excalidraw. You can use it to self host your own client under your own domain, on Kubernetes, AWS ECS, etc.

docker build -t excalidraw/excalidraw .
docker run --rm -dit --name excalidraw -p 5000:80 excalidraw/excalidraw:latest

The Docker image is free of analytics and other tracking libraries.

At the moment, self-hosting your own instance doesn't support sharing or collaboration features.

We are working towards providing a full-fledged solution for self hosting your own Excalidraw.

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Translating

To translate Excalidraw into other languages, please visit our Crowdin page. To add a new language, open an issue so we can get things set up on our end first.

Translations will be available on the app if they exceed a certain threshold of completion (currently 85%).

Excalidraw is built using these awesome tools

• React
• Rough.js
• TypeScript
• Vercel

And the main source of inspiration for starting the project is the awesome Zwibbler app.

Testimonials

Contributors

Code Contributors

This project exists thanks to all the people who contribute. [Contribute].

Financial Contributors

Become a financial contributor and help us sustain our community. [Contribute]

Individuals

Organizations

Support this project with your organization. Your logo will show up here with a link to your website. [Contribute]