Skip to content

II: Setting up your environment

llvallejo93 edited this page Jan 8, 2019 · 1 revision

Pre-Requisites:

Below is a provided link to the list of software pre-requisites specified by the Samvera-Hyrax Repository on github. These tools are necessary in order to be able to develop your application using the Hyrax stack. To facilitate your search for them, each bullet point has the software name underlined with a hyperlink that takes you directly to their download page.

https://github.com/samvera/hyrax#user-content-prerequisites

Hyrax Requirements:

  1. Solr version >= 5.x (tested up to 7.0.0)
  2. Fedora Commons digital repository version >= 4.5.1 (tested up to 4.7.5)
  3. A SQL RDBMS (MySQL, PostgreSQL), though note that SQLite will be used by default if you're looking to get up and running quickly
  4. Redis, a key-value store
  5. ImageMagick with JPEG-2000 support
  6. FITS version 1.0.x (1.0.5 is known to be good, 1.1.0 is known to be bad: https://github.com/harvard-lts/fits/issues/140)
  7. LibreOffice
  8. ffmpeg
  9. NOTE: The Hyrax Development Guide has instructions for installing Solr and Fedora in a development environment.

Local Development Environment Requirements:

Some other software development tools you may require to be set up before starting your app development are

  1. A code editor (Visual Studio Code preferably)
  2. The latest Ruby Version Manager (RVM)
  3. Ruby Version >= 2.4.5
  4. Rails Version >= 5.1.6
  5. The latest Google Chrome Browser.
  6. GitHub Desktop
  7. Make sure that you have access to a command prompt/powershell/terminal on your local machine.