Skip to content

cul/triclops

Folders and files

NameName
Last commit message
Last commit date
Dec 23, 2024
Nov 7, 2023
Dec 24, 2024
Sep 26, 2023
Jan 9, 2025
Dec 17, 2024
Nov 8, 2019
Dec 24, 2024
Sep 24, 2019
Nov 8, 2023
Dec 24, 2024
Sep 24, 2019
Sep 24, 2019
Sep 24, 2019
Sep 24, 2019
Jan 17, 2024
Jan 16, 2024
Sep 24, 2019
Dec 23, 2024
Jan 17, 2024
Nov 7, 2023
Nov 8, 2023
Dec 22, 2024
Dec 22, 2024
Sep 26, 2023
May 31, 2022
Nov 8, 2019
Jan 17, 2024
Sep 24, 2019
Apr 11, 2022
Jan 16, 2024
Sep 26, 2023
Jan 16, 2024

Repository files navigation

Triclops: A triple-eye-f (IIIF) Server

Triclops is a cool IIIF server.

Requirements

  • Ruby 3.0
  • Redis 3
  • libvips (for Imogen image conversion gem dependency)
  • Node 10 or 12

First-Time Setup (for developers)

git clone [email protected]:cul/ren-triclops.git # Clone the repo
cd ren-triclops # Switch to the application directory
# Note: Make sure rvm has selected the correct ruby version. You may need to move out of the directory and back into it force rvm to use the ruby version specified in .ruby_version.
bundle install # Install gem dependencies
yarn install # this assumes you have node and yarn installed (tested with Node 10)
bundle exec rake triclops:setup:config_files # Set up config files like redis.yml and resque.yml
bundle exec rake triclops:setup:sample_resources # Set up sample Resource objects ('sample' and 'sample-with-transparency')
bundle exec rake db:migrate # Run database migrations
rails s -p 3000 # Start the application using rails server

Testing

Our testing suite runs Rubocop and then runs all of our ruby tests. Travis CI will automatically run the test suite for every commit and pull request.

To run the continuous integration test suite locally on your machine run:

bundle exec rake triclops:ci

If you don't have redis on your machine, you can exclude tests that require redis by running:

bundle exec rake triclops:ci EXCLUDE_SPECS=redis

Attribution

Free-to-use "Grey and White Long Coated Cat in Middle of Book Son Shelf" stock photo from Pexels.com: https://www.pexels.com/photo/grey-and-white-long-coated-cat-in-middle-of-book-son-shelf-156321/