Code Monkey home page Code Monkey logo

whiteboard-1's Introduction

whiteboard

This is a lightweight NodeJS collaborative Whiteboard/Sketchboard witch can easily be customized...

start

Some Features

  • Showing remote user cursors while drawing
  • Undo function for each user (strg+z as well)
  • Drag & Drop Images to Whiteboard from PC and Browsers
  • Copy & Paste Images from Clipboard to the Whiteboard
  • 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)
  • Working on PC, Tablet & Mobile

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

With Helm

Locally

  1. helm install --name whiteboard ./helm/whiteboard/ -f ./helm/whiteboard/values.yaml

Push to an s3 bucket and add as a helm repo (such as minio)

  1. create a minio bucket
  2. package the helm chart helm package ./helm/whiteboard
  3. create an index file with the path to your helm repo included so that all charts get the base url
    helm repo index . --url https://location.of/bucket
    
  4. move packaged helm chart (ex whiteboard-0.0.1.tgz) and index.yaml file to s3 bucket
  5. add your bucket with helm repo add whiteboard https://location.of/bucket
  6. helm install from bucket with helm install whiteboard/whiteboard --name whiteboard

API

Call your site with GET parameters to change the WhiteboardID or the Username

http://YOURIP:8080?whiteboardid=MYID&username=MYNAME

  • whiteboardid => All people with the same ID are drawing on the same board
  • username => The name witch is showing to others while drawing

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)

ToDo

  • Add feedback for errors and things ...

Nginx Reverse Proxy configuration

Add this to your server part:

    location /whiteboard/ {
        proxy_set_header HOST $host;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection upgrade;
        proxy_pass http://YOURIP:8080/;
    }

To run it at /whiteboard. Don't forget to change -> YOURIP!

Nextcloud integration

  1. Install this app on your server
  2. Enable and go to "external sites" on your Nextcloud
  3. Add Link to your server: https://YOURIP/whiteboard/?whiteboardid=WHITEBOARDNAME&username={uid} You can give each group its own whiteboard by changeing the WHITEBOARDNAME in the URL if you want.

Note: You might have to serve the app with https (If your nextcloud server runs https). To do so, its recommend to run this app behind a reverse proxy. (as shown above)

___ MIT License ___

whiteboard-1's People

Contributors

cracker0dks avatar mjschmidt avatar q11bul avatar

Stargazers

 avatar  avatar _KrEdEnS_ avatar

Watchers

James Cloos avatar

Forkers

hoangleduy27

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.