gophergala2016/fireup

Name: fireup

Owner: gophergala2016

Description: Push and broadcast markdown slides on the fly

Created: 2016-01-22 19:20:54.0

Updated: 2018-02-05 17:31:50.0

Pushed: 2016-01-25 00:20:20.0

Homepage:

Size: 401

Language: Go

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

fireup

Fireup is a tool for dynamically broadcasting markdown slides to all browser clients connected to it. It has two modes of operation, the server mode and the client mode.

Fireup can be thought of as a virtual whiteboard for a conference or any such collaborative endeavour. Start fireup in server mode and share it's web url to all participants or on a projector. Now all participants can push their content to the server.

Installation

To install fireup use the following command

(NOTE: you must have Go installed before you can install fireup)

 get github.com/gophergala2016/fireup

this will download fireup in your $GOPATH. Now use go build command within the fireup directory in GOPATH to build the fireup binary. Now place the binary somewhere in your path.

Usage

Run fireup in server mode with the command

reup s
/01/25 04:56:08 starting http listener on http://0.0.0.0:8080
/01/25 04:56:08 starting push listener on 0.0.0.0:8081

and share the url of the http listener to all participants. At this point all browsers pointing to this url will see the following screen

Now push slides to the server using the push command as follows

reup p ./samples/gopher.md

fireup then broadcasts the slide to all browser clients connected to fireup instance running in server mode. The screenshot below displays the slide pushed to the browser window.

some cool uses of fireup

ad -10 main.go | fireup p
r s in `ls samples/*.md` ; do cat $s| fireup p; sleep 4; done
ho "<pre>`ls -l`</pre>"| fireup p

for a detailed help on the commands and their flags, see the usage message below.

reup 
:
ireup - push markdown slides on the fly.

E:
ireup [global options] command [command options] [arguments...]

ION:
.0.0

ANDS:
erve, s start in server mode
ush, p  push slide.
elp, h  Shows a list of commands or help for one command

AL OPTIONS:
-help, -h       show help
-version, -v    print the version
Sample slides

For some sample slides, look in the samples folder.

Features to be added soon
  1. Support for file types other than markdown.
  2. Support for pushing audio and video files.

License

MIT License. See here


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.