WebDev/VersaWhiteboard
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
Cracker 2018-02-09 00:12:29 +01:00 committed by GitHub
parent 4e1956542c
commit bb96176315
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 31 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -1,2 +1,32 @@
# whiteboard
Collaborative Whiteboard / Sketchboard
This is a lightweight collaborative Whiteboard witch can easily be customized...
![start](./doc/start.png)
## Some Features
* Showing remote user cursors while drawing
* Undo function for each user
* Drag & Drop Images to Whiteboard from PC and Browsers
* Copy & Paste Images from Clipboard
* Resize, Move & Draw Images to Canvas or Background
* Save Whiteboard to Image and JSON
* Draw angle lines by pressing "shift" while drawing (with line tool)
* Draw square by pressing "shift" while drawing (with rectangle tool)
## Install the App
You can run this app with and without docker
### Without Docker
1. install the latest NodeJs
2. Clone the app
3. Run `npm i` inside the folder
4. Run `node server.js`
5. Surf to http://YOURIP:8080
### With Docker
1. `docker run -d -p 8080:8080 rofl256/whiteboard`
2. Surf to http://YOURIP:8080
## Things you may want to know
* Whiteboards are gone if you restart the Server, so keep that in mind (or save your whiteboard)
* This is just a sample layout to show the functions available
* You shoud be able to customize without ever toutching the whiteboard.js (take a look at index.html & main.js)