Development

Local InstallationCopy Anchor Link

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

RequirementsCopy Anchor Link

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

Clone the repoCopy Anchor Link

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

Install the dependenciesCopy Anchor Link

yarn

Start the serverCopy Anchor Link

yarn start

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

CollaborationCopy Anchor Link

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

CommandsCopy Anchor Link

Install the dependenciesCopy Anchor Link

yarn

Run the projectCopy Anchor Link

yarn start

Reformat all files with PrettierCopy Anchor Link

yarn fix

Run testsCopy Anchor Link

yarn test

Update test snapshotsCopy Anchor Link

yarn test:update

Test for formatting with PrettierCopy Anchor Link

yarn test:code

Docker ComposeCopy Anchor Link

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-hostingCopy Anchor Link

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.