excalidraw

Excalidraw is a whiteboard tool that lets you easily sketch diagrams with a hand-drawn feel.

Try it now

Go to https://excalidraw.com to start sketching.

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

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 Installation

A production-ready version for deploying to e.g. Kubernetes or OpenShift can be built using Docker.

Docker Compose

docker-compose up --build -d

Native Docker

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

After building the image and running the container, open http://localhost:5000 to see the application.

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.

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]