This project is a proof-of-concept implementation of a whiteboarding protocol created as an assignment for the ELEC-E7320 Internet Protocols course at Aalto University.
Live demo: trunkless-whiteboard.website
The repository is a Lerna monorepo consisting of the following packages:
backend- centralized server codeclient- user client for interacting with the server from a whiteboardencoding- shared library betweenclientandserverbenchmarks- benchmarking scripts and analysis of the protocol/system
Alternatively to the manual steps below, you may opt for using our Docker image:
docker run \
--name="trunkless-whiteboard" \
--publish 3001:3001 \
--detach \
docker.pkg.github.com/wgslr/trunkless-whiteboard/app-image
The app should now be accessible at localhost:3001.
Ensure that you have the following follow installed on you machine:
yarnversion>=1.22.0nodeversion>=15.10.0protocversion>=3.13.0
First install all Node modules in the root folder:
yarn
Generate the protobuf type definitions:
yarn protoc
Link packages together:
yarn bootstrap
To run a development setup, the easiest way is to run the following in the root folder:
yarn start:dev
This will start the server and a client for you.
The client is exposed at localhost:3000 by default.
You may also run each package separately by entering the package folders and running the same commands.
First build a production build (run from root folder):
yarn build:prod
The execute the production build with:
yarn exec:prod
The app should now be exposed at localhost:3001.
If you want to setup a public server configuration on your own, see server_configuration.