A Project Blacklight based Rails engine that supports the discovery of web archives held in the WARC and ARC formats. It allows faceted full-text search, record view, and other advanced discovery options.
Add this line to your application's Gemfile:
And then execute:
Or install it yourself as:
$ gem install warclight
For further details, see our Creating, installing, and running your Warclight application documentation.
Run the test suite
Ensure Solr and Rails are not running (ports 8983 and 3000 respectively), then:
$ bundle exec rake
Run a development server
$ bundle exec rake warclight:server
Then visit http://localhost:3000. It will also start a Solr instance on port 8983.
Run a console
You can also run
bin/console for an interactive prompt that will allow you to experiment.
Release a new version of the gem
To release a new version:
- Update the version number in
bundle exec rake release, which will create a git tag for the version, push git commits and tags, build the gem file (e.g.,
gem build warclight.gemspec) and push the
.gemfile to rubygems.org (e.g.,
gem push warclight-x.y.z.gem).
The gem is available as open source under the terms of the Apache License, Version 2.0.
This work is primarily supported by the Andrew W. Mellon Foundation. Other financial and in-kind support comes from the Social Sciences and Humanities Research Council, Compute Canada, the Ontario Ministry of Research, Innovation, and Science, York University Libraries, Start Smart Labs, and the Faculty of Arts and David R. Cheriton School of Computer Science at the University of Waterloo.
Any opinions, findings, and conclusions or recommendations expressed are those of the researchers and do not necessarily reflect the views of the sponsors.