Enabling society to collaborate. Building a better future, together.

Alkemio fork of Excalidraw v0.13.0

Modifications:

• ZoomToFit feature exposed through the external API
• Added ZoomToFit button to the zoom toolbar
• Added ZoomToFit flag to initialData to fit items on load

Development guidelines

• First of all, Excalidraw uses yarn as package manager, so first thing to do is make sure you have yarn installed in your system. npm install --global yarn.
• Clone the repository to a local folder: git clone [email protected]:alkem-io/excalidraw.git and create a feature branch to store your work.
• Follow the original Excalidraw instructions below to run and debug with the included test application - Just yarn ; yarn start should work.
• To test/debug Excalidraw inside our client-web application:
  • Execute npm link in the root of your cloned repository.
  • Go to your client-web folder and execute: npm link @alkemio/excalidraw --save
• When you're done with the development commit and push everything, create a Pull Request in the alkem-io/excalidraw repository to merge your branch to develop.
• Once is merged to develop, checkout develop branch and see below how to build and publish the package to NPM repository.
• Make sure you switch back the package in your client-web to use the published @alkemio/excalidraw package's new version instead of the old one or the linked one if you changed it.

Build and publish a new npm package:

## Update this version with every published package
VERSION=8
git clone [email protected]:alkem-io/excalidraw.git
git checkout develop
yarn
yarn build
## Ensure that scripts/updateChangelog.js:39 is set to your current branch - you should be building from develop or from main
git commit --allow-empty -m "release @[email protected]$VERSION"
yarn run prerelease 0.13.0-alkemio-$VERSION
## Sometimes - not sure why - next step tries to run prerelease again, remove the script from package.json
## Also prerelease deletes public/service-worker.js needs to be manually restored after releasing
yarn run release

---

Virtual whiteboard for sketching hand-drawn like diagrams.
Collaborative and end-to-end encrypted.

Ask questions or hang out on our discord.gg/UexuTaE.

Try it now

Go to excalidraw.com to start sketching.

Read the latest news and updates on our blog. A good start is to see all the updates of One Year of Excalidraw.

Supporting Excalidraw

If you like the project, you can become a sponsor at Open Collective.

Last but not least, we're thankful to these companies for offering their services for free:

Who's integrating Excalidraw

Google Cloud • Meta • CodeSandbox • Obsidian Excalidraw • Replit • Slite • Notion • HackerRank •

Documentation

Shortcuts

You can almost do anything with shortcuts. Click on the help icon on the bottom right corner to see them all.

Curved lines and arrows

Choose line or arrow and click click click instead of drag.

Charts

You can easily create charts by copy pasting data from Excel or just plain comma separated text.

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%).

Create a collaboration session manually

In order to create a session manually, you just need to generate a link of this form:

https://excalidraw.com/#room=[0-9a-f]{20},[a-zA-Z0-9_-]{22}

Example

https://excalidraw.com/#room=91bd46ae3aa84dff9d20,pfLqgEoY1c2ioq8LmGwsFA

The first set of digits is the room. This is visible from the server that’s going to dispatch messages to everyone that knows this number.

The second set of digits is the encryption key. The Excalidraw server doesn’t know about it. This is what all the participants use to encrypt/decrypt the messages.

Note: Please ensure that the encryption key is 22 characters long.

Shape libraries

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

Embedding Excalidraw in your App?

Try out @excalidraw/excalidraw. This package allows you to easily embed Excalidraw as a React component into your apps.

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.

Contributing

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

Notable used tools

• Create React App
• Rough.js
• TypeScript
• Vercel

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