https://github.com/performant-software/triple-eye-effable
An engine used for integration with the IIIF Cloud platform
https://github.com/performant-software/triple-eye-effable
Last synced: 6 months ago
JSON representation
An engine used for integration with the IIIF Cloud platform
- Host: GitHub
- URL: https://github.com/performant-software/triple-eye-effable
- Owner: performant-software
- License: mit
- Created: 2022-07-28T14:55:33.000Z (almost 4 years ago)
- Default Branch: master
- Last Pushed: 2025-08-29T18:58:45.000Z (10 months ago)
- Last Synced: 2025-08-29T21:01:20.953Z (10 months ago)
- Language: Ruby
- Size: 58.6 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: MIT-LICENSE
Awesome Lists containing this project
README
# Triple Eye Effable
TODO: Comment me
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'triple_eye_effable', git: 'https://github.com/performant-software/triple-eye-effable.git', tag: 'v0.1.0'
```
And then execute:
```bash
$ bundle install
```
Or install it yourself as:
```bash
$ gem install triple_eye_effable
```
Execute the follow to copy the necessary migrations into your application.
```bash
$ bundle exec rails triple_eye_effable:install:migrations
```
Run the migrations.
```bash
$ bundle exec rake db:migrate
```
## Configuration
Add the following to `config/initializers/triple_eye_effable.rb`:
```ruby
TripleEyeEffable.configure do |config|
config.api_key = ENV['IIIF_CLOUD_API_KEY']
config.url = ENV['IIIF_CLOUD_URL']
config.project_id = ENV['IIIF_CLOUD_PROJECT_ID']
end
```
## Resource Transfer
The `triple-eye-effable` gem comes packages with a rake task to assist with managing data. Let's say you want to pull a backup of your application's staging or production environment locally to test. You can easily restore the database, however all of the IIIF resources are still on the staging or production IIIF Cloud instance.
The following rake task will allow for "pulling" the resources and uploading them to another IIIF Cloud instance (either hosted locally, or somewhere else):
```shell
bundle exec rake triple_eye_effable:transfer_resources -- --api-key --api-url --project-id
```