Development

Code Sandbox

• Go to https://codesandbox.io/p/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.

Requirements

• Node.js
• Yarn (v1 or v2.4.2+)
• Git

Clone the repo

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

Install the dependencies

yarn

Start the server

yarn start

Now you can open http://localhost:3000 and start coding in your favorite code editor.

Collaboration

For collaboration, you will need to set up collab server in local.

Commands

Install the dependencies

yarn

Run the project

yarn start

Reformat all files with Prettier

yarn fix

Run tests

yarn test

Update test snapshots

yarn test:update

Test for formatting with Prettier

yarn test:code

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.