{"id":15310903,"url":"https://github.com/gsimone/excalidraw","last_synced_at":"2025-10-08T18:32:32.786Z","repository":{"id":43168859,"uuid":"470079254","full_name":"gsimone/excalidraw","owner":"gsimone","description":"Virtual whiteboard for sketching hand-drawn like diagrams","archived":false,"fork":true,"pushed_at":"2022-07-06T10:44:42.000Z","size":34646,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-01-23T00:04:38.319Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://excalidraw.com","language":"TypeScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"excalidraw/excalidraw","license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/gsimone.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"open_collective":"excalidraw"}},"created_at":"2022-03-15T09:02:15.000Z","updated_at":"2023-03-07T13:35:41.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/gsimone/excalidraw","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gsimone%2Fexcalidraw","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gsimone%2Fexcalidraw/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gsimone%2Fexcalidraw/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/gsimone%2Fexcalidraw/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/gsimone","download_url":"https://codeload.github.com/gsimone/excalidraw/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235745915,"owners_count":19038968,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-01T08:29:54.854Z","updated_at":"2025-10-08T18:32:27.257Z","avatar_url":"https://github.com/gsimone.png","language":"TypeScript","funding_links":["https://opencollective.com/excalidraw","https://opencollective.com/excalidraw/tiers/sponsors/0/website","https://opencollective.com/excalidraw/tiers/sponsors/1/website","https://opencollective.com/excalidraw/tiers/sponsors/2/website","https://opencollective.com/excalidraw/tiers/sponsors/3/website","https://opencollective.com/excalidraw/tiers/sponsors/4/website","https://opencollective.com/excalidraw/tiers/sponsors/5/website","https://opencollective.com/excalidraw/tiers/sponsors/6/website","https://opencollective.com/excalidraw/tiers/sponsors/7/website","https://opencollective.com/excalidraw/tiers/sponsors/8/website","https://opencollective.com/excalidraw/tiers/sponsors/9/website","https://opencollective.com/excalidraw/tiers/sponsors/10/website"],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\" style=\"display:flex;flex-direction:column;\"\u003e\n  \u003ca href=\"https://excalidraw.com\"\u003e\n    \u003cimg width=\"540\" src=\"./public/og-image-sm.png\" alt=\"Excalidraw logo: Sketch handrawn like diagrams.\" /\u003e\n  \u003c/a\u003e\n  \u003ch3\u003eVirtual whiteboard for sketching hand-drawn like diagrams.\u003cbr\u003eCollaborative and end-to-end encrypted.\u003c/h3\u003e\n  \u003cp\u003e\n    \u003ca href=\"https://twitter.com/Excalidraw\"\u003e\n      \u003cimg alt=\"Follow Excalidraw on Twitter\" src=\"https://img.shields.io/twitter/follow/excalidraw.svg?label=follow+excalidraw\u0026style=social\u0026logo=twitter\"\u003e\n    \u003c/a\u003e\n    \u003ca target=\"_blank\" href=\"https://crowdin.com/project/excalidraw\"\u003e\n      \u003cimg src=\"https://badges.crowdin.net/excalidraw/localized.svg\"\u003e\n    \u003c/a\u003e\n  \u003c/p\u003e\n  \u003cp\u003eAsk questions or hang out on our \u003ca target=\"_blank\" href=\"https://discord.gg/UexuTaE\"\u003ediscord.gg/UexuTaE\u003c/a\u003e.\u003c/p\u003e\n\u003c/div\u003e\n\n## Try it now\n\nGo to [excalidraw.com](https://excalidraw.com) to start sketching.\n\nRead the latest news and updates on our [blog](https://blog.excalidraw.com). A good start is to see all the updates of [One Year of Excalidraw](https://blog.excalidraw.com/one-year-of-excalidraw/).\n\n## Supporting Excalidraw\n\nIf you like the project, you can become a sponsor at [Open Collective](https://opencollective.com/excalidraw).\n\n[\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/0/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/0/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/1/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/1/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/2/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/2/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/3/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/3/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/4/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/4/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/5/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/5/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/6/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/6/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/7/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/7/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/8/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/8/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/9/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/9/website) [\u003cimg src=\"https://opencollective.com/excalidraw/tiers/sponsors/10/avatar.svg?avatarHeight=120\"\u003e](https://opencollective.com/excalidraw/tiers/sponsors/10/website)\n\n\u003ca href=\"https://opencollective.com/excalidraw#category-CONTRIBUTE\" target=\"_blank\"\u003e\u003cimg src=\"https://opencollective.com/excalidraw/tiers/backers.svg?avatarHeight=32\"/\u003e\u003c/a\u003e\n\nLast but not least, we're thankful to these companies for offering their services for free:\n\n[![Vercel](./.github/assets/vercel.svg)](https://vercel.com) [![Sentry](./.github/assets/sentry.svg)](https://sentry.io) [![Crowdin](./.github/assets/crowdin.svg)](https://crowdin.com)\n\n## Who's integrating Excalidraw\n\n[Google Cloud](https://googlecloudcheatsheet.withgoogle.com/architecture) • [Meta](https://meta.com/) • [CodeSandbox](https://codesandbox.io/) • [Obsidian Excalidraw](https://github.com/zsviczian/obsidian-excalidraw-plugin) • [Replit](https://replit.com/) • [Slite](https://slite.com/) • [Notion](https://notion.so/) • [HackerRank](https://www.hackerrank.com/) •\n\n## Documentation\n\n### Shortcuts\n\nYou can almost do anything with shortcuts. Click on the help icon on the bottom right corner to see them all.\n\n### Curved lines and arrows\n\nChoose line or arrow and click click click instead of drag.\n\n### Charts\n\nYou can easily create charts by copy pasting data from Excel or just plain comma separated text.\n\n### Translating\n\nTo translate Excalidraw into other languages, please visit [our Crowdin page](https://crowdin.com/project/excalidraw). To add a new language, [open an issue](https://github.com/excalidraw/excalidraw/issues/new) so we can get things set up on our end first.\n\nTranslations will be available on the app if they exceed a certain threshold of completion (currently 85%).\n\n### Create a collaboration session manually\n\nIn order to create a session manually, you just need to generate a link of this form:\n\n```\nhttps://excalidraw.com/#room=[0-9a-f]{20},[a-zA-Z0-9_-]{22}\n```\n\n#### Example\n\n```\nhttps://excalidraw.com/#room=91bd46ae3aa84dff9d20,pfLqgEoY1c2ioq8LmGwsFA\n```\n\nThe 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.\n\nThe 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.\n\n\u003e Note: Please ensure that the encryption key is 22 characters long.\n\n## Shape libraries\n\nFind a growing list of libraries containing assets for your drawings at [libraries.excalidraw.com](https://libraries.excalidraw.com).\n\n## Embedding Excalidraw in your App?\n\nTry out [`@excalidraw/excalidraw`](https://www.npmjs.com/package/@excalidraw/excalidraw). This package allows you to easily embed Excalidraw as a React component into your apps.\n\n## Development\n\n### Code Sandbox\n\n- Go to https://codesandbox.io/s/github/excalidraw/excalidraw\n  - You may need to sign in with GitHub and reload the page\n- You can start coding instantly, and even send PRs from there!\n\n### Local Installation\n\nThese instructions will get you a copy of the project up and running on your local machine for development and testing purposes.\n\n#### Requirements\n\n- [Node.js](https://nodejs.org/en/)\n- [Yarn](https://yarnpkg.com/getting-started/install) (v1 or v2.4.2+)\n- [Git](https://git-scm.com/downloads)\n\n#### Clone the repo\n\n```bash\ngit clone https://github.com/excalidraw/excalidraw.git\n```\n\n#### Install the dependencies\n\n```bash\nyarn\n```\n\n#### Start the server\n\n```bash\nyarn start\n```\n\nNow you can open [http://localhost:3000](http://localhost:3000) and start coding in your favorite code editor.\n\n#### Collaboration\n\nFor collaboration, you will need to set up [collab server](https://github.com/excalidraw/excalidraw-room) in local.\n\n#### Commands\n\n##### Install the dependencies\n\n```\nyarn\n```\n\n##### Run the project\n\n```\nyarn start\n```\n\n##### Reformat all files with Prettier\n\n```\nyarn fix\n```\n\n##### Run tests\n\n```\nyarn test\n```\n\n##### Update test snapshots\n\n```\nyarn test:update\n```\n\n##### Test for formatting with Prettier\n\n```\nyarn test:code\n```\n\n#### Docker Compose\n\nYou can use docker-compose to work on Excalidraw locally if you don't want to setup a Node.js env.\n\n```sh\ndocker-compose up --build -d\n```\n\n### Self-hosting\n\nWe publish a Docker image with the Excalidraw client at [excalidraw/excalidraw](https://hub.docker.com/r/excalidraw/excalidraw). You can use it to self-host your own client under your own domain, on Kubernetes, AWS ECS, etc.\n\n```sh\ndocker build -t excalidraw/excalidraw .\ndocker run --rm -dit --name excalidraw -p 5000:80 excalidraw/excalidraw:latest\n```\n\nThe Docker image is free of analytics and other tracking libraries.\n\n**At the moment, self-hosting your own instance doesn't support sharing or collaboration features.**\n\nWe are working towards providing a full-fledged solution for self-hosting your own Excalidraw.\n\n## Contributing\n\nPull requests are welcome. For major changes, please [open an issue](https://github.com/excalidraw/excalidraw/issues/new) first to discuss what you would like to change.\n\n## Notable used tools\n\n- [Create React App](https://github.com/facebook/create-react-app)\n- [Rough.js](https://roughjs.com)\n- [TypeScript](https://www.typescriptlang.org)\n- [Vercel](https://vercel.com)\n\nAnd the main source of inspiration for starting the project is the awesome [Zwibbler](https://zwibbler.com/demo/) app.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgsimone%2Fexcalidraw","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgsimone%2Fexcalidraw","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgsimone%2Fexcalidraw/lists"}