archivesunleashed/warclight

Name: warclight

Owner: Archives Unleashed

Description: A Rails engine supporting the discovery of web archives.

Created: 2017-08-03 17:45:46.0

Updated: 2018-01-10 21:39:54.0

Pushed: 2018-01-12 22:39:42.0

Homepage: http://warclight.archivesunleashed.org/

Size: 13671

Language: Ruby

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

Warclight

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.

Requirements

• Ruby 2.2 or later
• Rails 5.1.2 or later

Installation

Add this line to your application's Gemfile:

'warclight'

And then execute:

ndle

Or install it yourself as:

m install warclight

For further details, see our Creating, installing, and running your Warclight application documentation.

Usage

Warclight is designed to work with web archive data that is indexed via the UK Web Archive's webarchive-discovery project. A guide on indexing is available here.

Development

Warclight development uses solr_wrapper and engine_cart to host development instances of Solr and Rails server on your local machine.

Run the test suite

Ensure Solr and Rails are not running (ports 8983 and 3000 respectively), then:

ndle exec rake

Run a development server

ndle 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:

1. Update the version number in lib/warclight/version.rb
2. Run 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 .gem file to rubygems.org (e.g., gem push warclight-x.y.z.gem).

Contributing

Bug reports and pull requests are welcome on WarcLight – see CONTRIBUTING.md for details.

License

The gem is available as open source under the terms of the Apache License, Version 2.0.

Acknowledgments

This work is primarily supported by the Andrew W. Mellon Foundation. Any opinions, findings, and conclusions or recommendations expressed are those of the researchers and do not necessarily reflect the views of the sponsors.

This project drew inspiration from the Arclight, and would like to thank those creators and contributors.