kalvee-whiteboard

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

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

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:

#### Example



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 Kalvee 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.kalvee.com](https://libraries.kalvee.com).

## Embedding Kalvee in your App?




#### Install the dependencies

```bash
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 kalvee 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 kalvee client at . You can use it to self-host your own client under your own domain, on Kubernetes, AWS ECS, etc.

docker build -t kalvee/kalvee .
docker run --rm -dit --name kalvee -p 5000:80 kalvee/kalvee: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 kalvee.

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.