Skip to content
A Rails engine supporting discovery of archival material
Ruby HTML XSLT JavaScript CSS
Branch: master
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.
app Fixes #979 where online content count badge was added multiple times Oct 29, 2019
bin Turn gem into an engine. Apr 14, 2017
config Update locale to display collection entry_name on pagination for… (#949) Oct 14, 2019
lib Bump to v0.3.0 Oct 29, 2019
solr/conf Updates online content to use list based search results with nex… (#965) Oct 21, 2019
spec Fixes #979 where online content count badge was added multiple times Oct 29, 2019
tasks Add some whitespace to address rubocop todos Sep 18, 2019
vendor/assets/javascripts 816 coll context tree scope note (#879) Oct 3, 2019
.all-contributorsrc Update contributors Sep 20, 2019
.babelrc babel??? Sep 5, 2019
.codeclimate.yml Add icons to collection/component show page breadcrumbs #801 (#847) Oct 4, 2019
.eslintrc
.gitignore Check if ESLint is installed when running the ESLint rake task. Also … Aug 22, 2019
.rspec initial commit Apr 11, 2017
.rubocop.yml Add icons to collection/component show page breadcrumbs #801 (#847) Oct 4, 2019
.rubocop_todo.yml Implemented an "expand" button for cases where the Collection Context Oct 1, 2019
.solr_wrapper Solr 7 changes Sep 26, 2017
.travis.yml Test with openjdk11 (#948) Oct 14, 2019
CONTRIBUTING.md add new CONTRIBUTING.md Jun 2, 2017
CONTRIBUTORS.md Update contributors Sep 20, 2019
Gemfile Add rubocop and rubocop-rspec. Apr 12, 2017
LICENSE.txt add Michigan Copyright to License.txt May 31, 2017
README.md Merge pull request #790 from projectblacklight/781 Sep 16, 2019
Rakefile Remove solr_ead indexing Aug 29, 2019
arclight.gemspec Update gemspec for Blacklight 7.2 compatibility (arclight relies on 7… Oct 11, 2019
package.json Adding CodeClimate overrides Oct 1, 2019
template.rb update blacklight 7 Aug 13, 2019

README.md

Build Status All Contributors Code Climate Test Coverage

ArcLight

A Rails engine supporting discovery of archival materials, based on Blacklight

ℹ️ From August-October 2019, Stanford University, University of Michigan, Indiana University, Princeton University, and Duke University are collaborating on a second phase of ArcLight! See the project board or our demo videos to follow our work.

Requirements

Installation

Installing ArcLight is straightforward in a Rails environment.

Basically, add this line to your application's Gemfile:

gem 'arclight'

And then execute:

$ bundle

Or install it yourself as:

$ gem install arclight

For further details, see our Installing ArcLight documentation.

Usage

Arclight is a Ruby gem designed to work with archival data. It can be installed on a server or virtual server. Once running, finding aids in the form of archival collection data can be imported into Arclight through an indexing process. Institutional and repositories data can also be added to Arclight (Currently this requires a developer. Configuration pages will be added for this in future versions). Additional finding aids can be added at any time.

After data indexing, Arclight can to be used to search, browse, and display the repositories (sets of collections), collections, and components within collections. Globally available search allows filtering on several types of terms (Keyword, Name, Place, etc.). Once a search is begun, it can be further narrowed using facets on the left side of the search page. Selecting a search result goes directly to that results show or display page. Also global available are buttons for Repositories and Collections which can be used an any time.

Browsing allows you to view the Overview or Contents (when it exists) of a collection. The Overview tab displays top level metadata about the collection. The Contents tab displays an outline view of a next level of the collection. You can expand each level by selecting (clicking). Selecting a component in the Contents views goes to a component page which shows the metadata for it.

Some pages include an inline view tab to the right of an item which will expand the Contents further.

See the ArcLight demo and ArcLight MVP Wiki for usage.

See Arclight Major Features for a list of features.

Traject indexing of EAD content

Traject is a high performance way of transforming documents for indexing into Solr and how ArcLight does indexing. An EAD2 can be indexed by doing the following:

bundle exec traject -u http://127.0.0.1:8983/solr/blacklight-core -i xml -c lib/arclight/traject/ead2_config.rb spec/fixtures/ead/sample/large-components-list.xml

Or

bundle exec rake arclight:seed

Resources

Contributors

See the CONTRIBUTORS file.

Development

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

$ bundle exec rake

If you find that the tests are failing when you run them on a Linux computer, you might need to install Google Chrome so the Selenium testing framework can run properly.

Run a development server

$ bundle exec rake arclight: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/arclight/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 arclight.gemspec) and push the .gem file to rubygems.org (e.g., gem push arclight-x.y.z.gem).

Contributing

Bug reports and pull requests are welcome on ArcLight -- see CONTRIBUTING.md for details.

License

The gem is available as open source under the terms of the Apache 2 License.

ArcLight also uses embedded SVG icons from the FontAwesome project. These icons are unmodified and licensed CC BY 4.0. All of these icons have the license and attribution embedded in them.

You can’t perform that action at this time.