slide

README

slide

present slides created in other programs nicely in a browser

present (a Golang tool) is great for creating clean, easy to make slides. But when you want to create well designed slides in another program (because let's be real, sometimes plain text and raw images don't cut it) it can be a hassle to get them running easily in a web browser and looking clean, and even harder to host them on a web server. Enter slide. Always spelled with a lowercase 's', especially at the beginning of sentences, slide helps people present things to the best of their ability.

Just slide and arrow-right to go!

slide in action

under the hood

Currently I'm taking the /www directory within this repo and converting that to binary data so that I can restore it onto the host machine within a temp directory (although you can use a permenant one if you want to host on a server persistantly, etc., though there really isn't much reason to because it 'recompiles' the static files every time you run the binary.) Before a Golang file server in instantiated, the www/ directory is first copied over to the host temp directory, and then the image/pdf slide directory specified (defaults to current working directory) is copied or converted (if the slides are a pdf, and needs image-magick for that) into the working directory under the naming scheme expected by the site's javascript.

Once the file server is listening on :3000 (or whatever else you set it to,) the JS checks which images exist under the expected naming schema and renders those slides under a custom Owl Carousel.

installation

with go get

from your $GOPATH, with $GOPATH/bin in your $PATH:

$ go get github.com/cdipaolo/slide
$ go install ./...
$ cp bin/slide /usr/bin/slide

# now just use as normal!

usage

place a pdf of your slideshow (created in whatever) as 'slides.pdf' or (with extensions JPG/JPEG/PNG) images of your slides (named *.png, *.jpg, or *.jpeg as long as the files will sort into the correct order) into a directory (lets call it slide-dir for now.) Run the following and open localhost:3000 (it'll prompt you anyways.)

As a note: slides will render better (have corners) if they are 1100px x 700px. This is the same as Golang's present rendering resolution.

That's it.

$ cd slide-dir
$ slide 

command line flags

• -no-tmp : Sets if you don't want to use the /tmp/ directory to host the static files, but you want to have the directory be set . Could be used if you want to host this persistantly on a server, although this isn't the most practical thing because the files are recopied every time. Defaults to false. When true, baseDir set to /.slide/
• -port : Sets the port to run the slide application from. Defaults to 3000
• -img : Set the directory containing either slides in pdf form (as slides.pdf), images – .jpg, .jpeg, or .png – separated as (1.png, 2.png, 3.png, etc.) Defaults to current directory. You'll need to not include '~' in the path as well. '.' will be expanded by Go but unless your bash will expand any other path before passing it the server will not recognize the path.
• -serve : Assigns the serving directory for the static files. Files will be copies into this directory. Defaults to {operating system temp dir}/slides{+ some random 32 bit unsigned integer}

license: MIT

see LICENSE for details.