1
0
mirror of https://github.com/excalidraw/excalidraw.git synced 2024-11-10 11:35:52 +01:00
Virtual whiteboard for sketching hand-drawn like diagrams
Go to file
2021-02-11 14:13:32 +02:00
.github chore: Run actions on pull requests as well (#2917) 2021-02-04 13:01:20 +01:00
firebase-project Persistent rooms via Firebase (#2188) 2020-10-04 11:12:47 -07:00
public feat: Add idle detection to collaboration feature (#2877) 2021-02-04 11:55:43 +01:00
scripts chore: Update translations from Crowdin (#2898) 2021-02-02 22:06:44 +00:00
src chore: Update translations from Crowdin (#3000) 2021-02-11 14:13:32 +02:00
.dockerignore Fix docker build (#2348) 2020-11-07 22:22:19 +00:00
.editorconfig add editorconfig (#1198) 2020-04-03 19:19:01 +02:00
.env chore: Update portal URL (#2689) 2020-12-28 13:14:22 +01:00
.env.production chore: Remove tracking (#2722) 2021-01-05 19:06:14 +01:00
.eslintignore add excalidraw_embed into base repo (#2040) 2020-08-20 16:45:20 +02:00
.eslintrc.json chore: Minor refactoring for consistency (#2425) 2020-11-29 17:32:51 +01:00
.gitattributes Add gitattributes (#2164) 2020-09-15 21:59:00 +02:00
.gitignore Add Arrowheads to Arrows (#2452) 2020-12-08 16:02:55 +01:00
.lintstagedrc.js Keep errors, elements and comments consistent (#2340) 2020-11-05 18:06:18 +01:00
.npmrc Add npmrc to have pinned deps (#727) 2020-02-07 13:59:23 +01:00
.nvmrc Add .nvmrc file (#1157) 2020-04-02 15:00:22 +03:00
.prettierignore Change target branch of coverage and pretty print (#1850) 2020-07-01 12:05:21 +03:00
.prettierrc docs: adding PR guidelines for contributors (#2736) 2021-01-06 22:53:12 +02:00
.watchmanconfig Don't reset cache while zooming using a gesture (#1103) 2020-03-28 16:59:36 -07:00
CHANGELOG.md support embedding scene data to PNG/SVG (#2219) 2020-10-13 14:47:07 +02:00
CONTRIBUTING.md feat: Updates to Collaboration and RTL UX (#2994) 2021-02-08 21:43:51 +01:00
crowdin.yml Locale 2020-03-19 20:38:52 +02:00
docker-compose.yml Fix docker-compose (#2388) 2020-11-22 15:59:17 +00:00
Dockerfile chore: Remove tracking (#2722) 2021-01-05 19:06:14 +01:00
LICENSE Add MIT License (#176) 2020-01-05 13:09:29 -08:00
package-lock.json fix: refresh wysiwyg position on canvas resize (#3008) 2021-02-11 12:24:26 +01:00
package.json fix: refresh wysiwyg position on canvas resize (#3008) 2021-02-11 12:24:26 +01:00
README.md docs(readme): link to @excalidraw/excalidraw npm package to give more visibility (#3002) 2021-02-10 21:58:29 +05:30
tsconfig.json fix: Consistent case for export locale strings (#2622) 2020-12-20 14:40:11 +02:00
vercel.json refactor: Use the latest vercel configuration instead of now (#2893) 2021-02-02 14:38:33 +01:00

Excalidraw logo: Sketch handrawn like diagrams.

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

Follow Excalidraw on Twitter

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.

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 thats going to dispatch messages to everyone that knows this number.

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

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

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 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

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