showKs Participant's App
Branch: master
Clone or download
kojiha Merge pull request #26 from containerdaysjp/kojiha
Fixed issues in touch force.
Latest commit b3db78c Dec 4, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
helm force tls Dec 2, 2018
src Fixed issues in touch force. Dec 4, 2018
.dockerignore Initial commit Sep 19, 2018
.gitignore Added new color picker Nov 28, 2018
Dockerfile add pango package Nov 7, 2018
LICENSE Initial commit Sep 19, 2018
README.md Merge pull request #23 from containerdaysjp/kojiha Dec 2, 2018

README.md

showKs Canvas

showKs Canvas is a simple collaborative whiteboard using socket.io. This is the participant's web application of Japan Container Days showKs.

How to modify

  1. Create your own branch.

  2. Edit src/data/author.json

  3. Send a pull request to be merged into staging branch

How to use

Run as a container

$ docker build -t <your username>/showks-canvas:<your tag> .
$ docker run -p <desired port>:8080 -d <your username>/showks-canvas:<your tag>

Run with Node.js runtime

$ cd src
$ npm install
$ npm start

Open http://<your host>:8080 with a web browser.

HTTP Endpoints

Endpoint Description
/ The whiteboard Web UI
/canvas Latest canvas image (PNG)
/thumbnail Canvas thumbnail (PNG)
/author Author information in (JSON)
/version Version information of Canvas

Author information format

{
    "userName": "Unique user name which identifies an instance",
    "gitHubId": "GitHub account of the author",
    "twitterId": "Twitter account of the author",
    "comment": "Comment shown in the listing"
}

Socket.IO Namespaces

Namespace Description
/notification Notifies the client of 'refresh' message with value 1 when the drawing is updated and there was no message sent within last 5 seconds.

License

MIT

This application is forked from Socket.IO Collaborative Whiteboard example.