th5 / winterizer

Dewaxed version of Wax

TODO

---

minicomp/wax 🐝

jekyll for minimal exhibitions with iiif

demo site: https://minicomp.github.io/wax/
cannonical repo: https://github.com/minicomp/wax/
gem behind wax: https://github.com/minicomp/wax_tasks/

NOTE ~>   WAX, WAX_TASKS, and WAX_IIIF are in RAPID development and will be 
          unstable until the beta release (v0.5.0). 
          
          Please submit any bugs, questions, suggestions, feature requests, 
          and/or documentation edits as GitHub issues.
          Any feedback is helpful/appreciated !!!!

Welcome to the demo repository for the Minicomp/Wax minimal exhibition workflow.

The easiest way to get started with your own Wax exhibition is by cloning this repository and swapping out content, media, styles, and components to make it your your own.

Advanced users can check back to find a Ruby gem / Jekyll theme with the layouts, includes, and scripts from this demo.

Issues / Contributing

The canonical source for Wax is the Minicomp fork of the project. Please submit issues (bugs, feature requests, questions, etc.) as well as pull requests only to the Minicomp/Wax repository.

Primary tooling

Wax is a flexible workflow and not a platform. As such, its tooling is more of a dynamic roster than a stack. At its center are jekyll and wax_tasks (which are both Ruby gems), but the rest of the components are purely optional depending on what you'd like to do and how you'd like to do it. The following list is by no means exhaustive, but gives an outline of Wax's open source super group:

For searching/indexing:

• elasticlunr.js

For IIIF generation/presentation:

• wax_iiif gem (fork of iiif_s3https://github.com/cmoa/iiif_s3)
• leaflet.js and leaflet-iiif.js
• imagemagick

For theming:

• jquery
• bootstrap4

For testing:

• rspec gem
• html-proofer gem
• capybara gem
• travis-ci

Quick Start

Make sure your system is ready with modern Ruby (>=2.2), git, and ImageMagick installed.

Install Bundler

$ gem install bundler

Clone the repository and change directory into it

$ git clone https://github.com/minicomp/wax.git && cd wax

Install the Ruby Dependencies

$ bundle install

Serve the site locally

$ bundle exec jekyll serve

Check out the Minicomp Wiki to learn how to use and customize the demo components.