excalidraw

Virtual whiteboard for sketching hand-drawn like diagrams

canvas collaboration diagrams drawing hacktoberfest productivity whiteboard

Go to file

Kostas Bariotis 67805bc7a7 Add collaborators names (#1223 ) * add random usernames * add username state * add username input * ability to set names * fix tests * set username oon mobile * remove auto generated names * remove commented code * always string * updaate snapshots * maintain username when clearing canvas * Update src/renderer/renderScene.ts Co-Authored-By: Lipis <lipiridis@gmail.com> * add border * fix styles Co-authored-by: Pete Hunt <petehunt@users.noreply.github.com> Co-authored-by: Faustino Kialungila <faustino.kialungila@gmail.com> Co-authored-by: Lipis <lipiridis@gmail.com>		2020-04-07 14:02:42 +01:00
.github	Remove Sentry for staging workflow (#1147 )	2020-04-01 14:12:13 +03:00
public	Better title, for better look in search results, SEO (#1278 )	2020-04-06 18:58:20 +03:00
scripts	Bump prettier from 1.19.1 to 2.0.1 (#1060 )	2020-03-23 13:05:07 +02:00
src	Add collaborators names (#1223 )	2020-04-07 14:02:42 +01:00
.editorconfig	add editorconfig (#1198 )	2020-04-03 19:19:01 +02:00
.eslintignore	Much more thorough tests! (#1053 )	2020-03-23 16:38:41 -07:00
.gitignore	Full Screen mode (#1212 )	2020-04-06 00:47:13 +03:00
.lintstagedrc.js	Eslint tweaks (#696 )	2020-02-05 17:41:14 +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
.prettierrc	Set Trailing Cmma to (#525 )	2020-01-24 12:04:54 +02:00
.watchmanconfig	Don't reset cache while zooming using a gesture (#1103 )	2020-03-28 16:59:36 -07:00
CONTRIBUTING.md	fix(font): modify exclamation point in font (#394 )	2020-01-16 09:59:43 -08:00
LICENSE	Add MIT License (#176 )	2020-01-05 13:09:29 -08:00
README.md	Remove shortcuts (#1220 )	2020-04-05 16:24:23 +03:00
crowdin.yml	Locale	2020-03-19 20:38:52 +02:00
now.json	Add Security Headers (#1200 )	2020-04-04 02:36:12 +03:00
package-lock.json	Bump asar from 3.0.2 to 3.0.3 (#1264 )	2020-04-06 14:49:23 +03:00
package.json	Bump asar from 3.0.2 to 3.0.3 (#1264 )	2020-04-06 14:49:23 +03:00
tsconfig.json	Remove support for some older browsers that probably didn’t wor… (#1080 )	2020-03-25 17:42:16 +02:00

README.md

Excalidraw is a whiteboard tool that lets you easily sketch diagrams with a hand-drawn feel.

Try it now

Go to https://excalidraw.com to start sketching.

Read our blog and follow the guides to learn more about Excalidraw and how to use it effectively.

Run the code

Code Sandbox

Go to https://codesandbox.io/s/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.

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 run test:code`	Test for formatting with Prettier
`npm run test:app`	Test the app
`npm run test`	Run all tests
`npm run test -u`	Update all snapshots

Contributing

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

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.