Boomack Demo Site

web app for displaying hyper-media items in concert with e.g. an IDE

Inspired by ideas from Daniel Kiertscher

Install the CLI client

You need NodeJS ⪰ 10 with npm to install the current CLI client.

npm i -g boomack-cli

Send a Display Request with the CLI client

Then run one of the following example commands to publish a Media Item to the default Slot in the default Panel.

# send a string
boom --api https://boom.mastersign.de/ -s "Hello World!"

# send a picture file
boom --api https://boom.mastersign.de/ -f my-picture.png

# send a string as raw HTML
boom --api https://boom.mastersign.de/ -t text/html -s "<h1>I'm an Headline!</h1>"

# send a string with syntax highlighting
boom --api https://boom.mastersign.de/ -t text/plain -o syntax=html -s "<h1>Highlight me!</h1>"

# show what the client is sending to the server with the option --dry
boom --api https://boom.mastersign.de/ --dry -t text/plain -o syntax=javascript -s "var x = 1;\nconsole.log(x);"

You can use the option -l <panel>/<slot> to specify another target.

Send a Display Request without the CLI client

Bash

curl -H "Content-Type: application/json" \
  -d '{"text":"Hello World!"}' \
  https://boom.mastersign.de/v1/display

PowerShell

Invoke-WebRequest https://boom.mastersign.de/v1/display `
    -Method Post `
    -ContentType application/json `
    -Body '{"text":"Hello World!"}'

Run your own Boomack server with Docker

docker run --rm -it -p 127.0.0.1:3000:3000 mastersign/boomack

Install and run the Boomack server as global NodeJS package

You need NodeJS ⪰ 10 for the server to run.

npm i -g boomack

Then run the server and automatically open the default panel in your Browser.

boomack -b --panel default

Send a message to your local Boomack server

Send a message to your own local boomack server.

boom --api http://127.0.0.1:3000/ -s "Hello World!"

Because localhost on port 3000 is the default, you can just omit the API endpoint.

boom -s "Hello World!"