@mizchi/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.

Testimonials

Run the code

As a component

npm install excalidraw react react-dom

import React from "react";
import ReactDOM from "react-dom";
import { Excalidraw } from "excalidraw";

ReactDOM.render(
  <Excalidraw
    width={500}
    height={500}
    onChange={state => console.log(state)}
  />,
  document.querySelector("root"),
);

Code Sandbox

Go to https://codesandbox.io/s/github/excalidraw/excalidraw
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 run test:code`	Test for formatting with Prettier
`npm run test:app`	Test the app
`npm run test`	Run all tests

Contributing

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

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

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

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]