I'm trying to fix them together with others in this repository. Feel free to collaborate. 😎
This is a (hopefully temporary) fork from the original excalidraw project implementing:
- The recent version of Excalidraw (as of 2024-05-22)
- All the changes from b310-digital's fork (which brings support for rooms without using firebase). This fork is inspired and partly taken from Kilian Decaderincourt.
- The yarn-build-fix from squatica
- The redis db healthcheck from squatica
- My own improvements regarding the docker-compose files and the redis configuration
==THIS REPOSITORY SHOULD NOT BE SEEN AS MID / LONG TERM SOLUTION== I would really appreciate the upstream maintainers to implement some kind of self-hostable solution into their repository. But as long as pull requests to forks are outstanding for months and one has to fix a lot of different small issues until an up to date version of Excalidraw is up and running this repository will hopefully do it's job. 😎
Adapt the password in .env.default and rename it to .env.
Adapt the variables according to your needs in .env.development
Start the containers:
docker compose -f docker-compose-dev.yml up -d
Check the logs:
docker compose logs -t -f
Adapt the variables according to your needs in .env.production
Start the containers:
docker compose -f docker-compose-prod.yml up -d
Check the logs:
docker compose logs -t -f
The collaboration mode requires a secure context (https). Localhost works as well, but http over a local network will throw errors in the browser console.
Instructions taken from b310-digital's fork
==Dunno if those instructions are still up to date and working==
Please copy the .env.development.default or .env.production.default file to .env (or with environment without default at the end) and change it according to your needs, see react-scripts.
docker-compose up -d
docker-compose exec excalidraw yarn install
docker-compose exec excalidraw yarn start
Hint: Collab mode requires a secure context (https). Localhost works as well, but not http over local network.
| Command | Description |
|---|---|
yarn |
Install the dependencies |
yarn start |
Run the project |
yarn fix |
Reformat all files with Prettier |
yarn test |
Run tests |
yarn test:update |
Update test snapshots |
yarn test:code |
Test for formatting with Prettier |
Create beautiful hand-drawn like diagrams, wireframes, or whatever you like.
The Excalidraw editor (npm package) supports:
- 💯 Free & open-source.
- 🎨 Infinite, canvas-based whiteboard.
- ✍️ Hand-drawn like style.
- 🌓 Dark mode.
- 🏗️ Customizable.
- 📷 Image support.
- 😀 Shape libraries support.
- 👅 Localization (i18n) support.
- 🖼️ Export to PNG, SVG & clipboard.
- 💾 Open format - export drawings as an
.excalidrawjson file. - ⚒️ Wide range of tools - rectangle, circle, diamond, arrow, line, free-draw, eraser...
- ➡️ Arrow-binding & labeled arrows.
- 🔙 Undo / Redo.
- 🔍 Zoom and panning support.
The app hosted at excalidraw.com is a minimal showcase of what you can build with Excalidraw. Its source code is part of this repository as well, and the app features:
- 📡 PWA support (works offline).
- 🤼 Real-time collaboration.
- 🔒 End-to-end encryption.
- 💾 Local-first support (autosaves to the browser).
- 🔗 Shareable links (export to a readonly link you can share with others).
We'll be adding these features as drop-in plugins for the npm package in the future.
Note: following instructions are for installing the Excalidraw npm package when integrating Excalidraw into your own app. To run the repository locally for development, please refer to our Development Guide.
npm install react react-dom @excalidraw/excalidraw
or via yarn
yarn add react react-dom @excalidraw/excalidraw
Check out our documentation for more details!
- Missing something or found a bug? Report here.
- Want to contribute? Check out our contribution guide or let us know on Discord.
- Want to help with translations? See the translation guide.
Google Cloud • Meta • CodeSandbox • Obsidian Excalidraw • Replit • Slite • Notion • HackerRank • and many others
If you like the project, you can become a sponsor at Open Collective or use Excalidraw+.
Last but not least, we're thankful to these companies for offering their services for free:
