a place for your sketches
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
screen-shotter
test
.gitignore
LICENSE.md
README.md
frontend.js
index.js
live-reload.js
package-lock.json
package.json

README.md

sketchbook-cli — a place for your sketches

This is a prototyping and showcasing environment, including live-reloading and live-screenshotting of your code.

screenshot

Installation

npm install -g sketchbook-cli

Usage

Assuming that ./my-sketches is folder of single-file javascript sketches. They will be bundled with browserify on the fly, and gallery view of the sketches will be generated.

sketchbook-cli ./my-sketches

Then open the URL that will be printed out in the console. You can open any of the gallery items by clicking on it, and editing the code behind that sketch will be live-updated.

Options

  • --port 3000 - run on port 3000 instead of default random one
  • --no-screenshots - disable screenshotting (useful when working on battery)
  • -t - add browserify transform (eg. npm i glslify && sketchbook-cli . -t glslify)

Info

In the background, single electron is started, which screenshots each of the files one-by-one, and caches results in .sketchbook_cli folder inside of the main sketches directory. This folder ideally is in .gitignore.

The screenshot is generated immediately after page has loaded, which can sometimes result in white screen (while the sketch is still working). This can be controlled by adding window.sketchbook.shot() line somewhere in the code. Watch out: the way this works is done very naively, so for example commenting this line out, but leaving it in the source code, will lead to the screenshot never being taken.

Future Work

  • exporting gallery to static files

I'm happy to merge PRs!

Acknowledgments

Most of the live-reload code was stolen from budo.

This project was developed in part at Laboratory, an artist residency for interactive arts: https://laboratoryspokane.com.