Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/projectblacklight/arclight
A Rails engine supporting discovery of archival material
https://github.com/projectblacklight/arclight
archival-description archival-materials blacklight discovery ead gem ruby solr
Last synced: 22 days ago
JSON representation
A Rails engine supporting discovery of archival material
- Host: GitHub
- URL: https://github.com/projectblacklight/arclight
- Owner: projectblacklight
- License: other
- Created: 2017-04-07T19:05:25.000Z (about 7 years ago)
- Default Branch: main
- Last Pushed: 2024-06-07T19:39:01.000Z (25 days ago)
- Last Synced: 2024-06-08T04:26:38.570Z (24 days ago)
- Topics: archival-description, archival-materials, blacklight, discovery, ead, gem, ruby, solr
- Language: Ruby
- Homepage: https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211890/ArcLight
- Size: 2.28 MB
- Stars: 38
- Watchers: 31
- Forks: 22
- Open Issues: 141
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Lists
- awesome-archivesspace - ArcLight - based environment to support discovery and delivery for archives and special collections, initiated by Stanford University Libraries in late 2014. The vision for ArcLight has been to support discovery and delivery of archives and special collections (both physical and digital), to improve presentation and usability for archival description, and to enable integration with systems like Samvera, ArchivesSpace, and request management systems.” [ArcLight wiki](https://samvera.atlassian.net/wiki/spaces/samvera/pages/405211890/ArcLight), [ArcLight Google Group](https://groups.google.com/g/arclight-community?pli=1), [ArcLight YouTube](https://www.youtube.com/channel/UCbSaP93HdypsW6hXy7V1nFQ) (Integrations / Aggregated Discovery Layers)
README
[](https://badge.fury.io/rb/arclight)
[](https://badge.fury.io/js/arclight)
[](CONTRIBUTORS.md)
[](https://codeclimate.com/github/projectblacklight/arclight/coverage)
# ArcLight
A Rails engine supporting discovery of archival materials, based on [Blacklight](https://projectblacklight.org/)
## Requirements
* [Ruby](https://www.ruby-lang.org/en/) 3.0.3 or later
* [Rails](http://rubyonrails.org) 7.0 or later
* Solr 8.1 or later
## Installation
[Installing ArcLight](https://github.com/projectblacklight/arclight/wiki/Creating,-installing,-and-running-your-ArcLight-application) is straightforward in a Rails environment.
Basically, add this line to your application's `Gemfile`:
```ruby
gem 'arclight'
```
And then execute:
```sh
$ bundle
```
Or install it yourself as:
```sh
$ gem install arclight
```
For further details, see our [Installing ArcLight](https://github.com/projectblacklight/arclight/wiki/Creating,-installing,-and-running-your-ArcLight-application) 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](https://arclight-demo.projectblacklight.org/) and [ArcLight MVP Wiki](https://github.com/projectblacklight/arclight/wiki) for usage.
See [Arclight Major Features](https://github.com/projectblacklight/arclight/wiki/Arclight-Major-Features) for a list of features.
### Traject indexing of EAD content
[Traject](https://github.com/traject/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:
```sh
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
```sh
bundle exec rake arclight:seed
```
## Resources
* General
* [ArcLight demo site](https://arclight-demo.projectblacklight.org/)
* [ArcLight Github wiki](https://github.com/projectblacklight/arclight/wiki): developer/implementor documentation
* [Blacklight wiki](https://github.com/projectblacklight/blacklight/wiki)
* Use the [ArcLight Google Group](http://groups.google.com/d/forum/arclight-community) to contact us with questions
* ArcLight MVP:
* [MVP sprint demo videos](https://www.youtube.com/playlist?list=PLMdUaIJ0G8QgbuDCUVvFhTSTO96N37lRA)
## Contributors
See the [CONTRIBUTORS](CONTRIBUTORS.md) file.
## Development
ArcLight requires Solr to be running. For development you can start this using `solr_wrapper` or you may choose to use Docker. Start Solr using Docker by doing `docker compose up`.
### Run the test suite
Ensure Solr and Rails are _not_ running (ports 8983 and 3000 respectively), then:
```sh
$ 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
```sh
$ 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.
### Releasing
#### To release a new gem:
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](https://rubygems.org) (e.g., `gem push arclight-x.y.z.gem`).
#### To release the frontend sources:
When any of the javascript components or SASS sources in the gem are changed, this package should be published to NPM with the following steps:
1. [Install npm](https://www.npmjs.com/get-npm)
2. Bump the version number in `package.json`
3. run `npm run build && npm publish` to push the javascript package to https://npmjs.org/package/arclight
## Contributing
[Bug reports](https://github.com/projectblacklight/arclight/issues) and [pull requests](https://github.com/projectblacklight/arclight/pulls) are welcome on ArcLight -- see [CONTRIBUTING.md](https://github.com/projectblacklight/arclight/blob/main/CONTRIBUTING.md) for details.
## License
The gem is available as open source under the terms of the [Apache 2 License](https://opensource.org/licenses/Apache-2.0).
ArcLight also uses embedded SVG icons from the [FontAwesome](https://fontawesome.com) project. These icons are unmodified and licensed [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/). All of these icons have the license and attribution embedded in them.