Arch
Arch is our institutional repository and is a Hyrax 2 application.
Environments
Software Architecture
Arch is hosted on AWS. It's using NUL's shared Fedora 4 instance and has it's own Solr core on a shared Solr instance.
Developer Dependencies
These should match closely with the Hyrax requirements:
- Ruby 2.3.0 and rbenv, Bundler (https://github.com/rbenv/rbenv#homebrew-on-mac-os-x)
- If you get permission errors running
gem install bundler
, try the following:
- Set your global ruby environment by running:
rbenv global 2.3.0
- In your user's .bash_profile, include this line at the bottom: eval "\$(rbenv init -)"
- Open a new terminal window and run:
gem install bundler
- Download and install LibreOffice https://www.libreoffice.org/download/download/
- Imagemagick
brew install imagemagick --with-ghostscript --with-openjpeg
- ffmpeg
brew install ffmpeg --with-fdk-aac --with-libvpx --with-libvorbis
- fits
brew install fits
- vips
brew install vips
- Install
devstack
according to the instructions in the README
- Follow the Dev Environment Setup instructions
Developer Installation
- Clone this repository
git clone git@github.com:nulib/arch.git
- From inside the project directory run
bundle install
- Start the docker stack with
devstack up arch
- From inside the project directory run
bundle exec rake arch:seed
- You can include the optional arguments to create an admin user (such as yourself). Ex:
bundle exec rake arch:seed ADMIN_USER=your_netid ADMIN_EMAIL=your_email@northwestern.edu
- In a separate tab, start the rails server
bundle exec rails server
- You can see the app in a browser at https://devbox.library.northwestern.edu:3000
Running the tests
- Start the test stack
devstack -t up arch
- Run the seed task for the test environment:
bundle exec rake arch:seed RAILS_ENV=test
- Run the test suite:
bundle exec rspec
Deploying
- Submit a PR in github to the environment's deploy branch
- To deploy to staging submit a PR to
deploy/staging
- To deploy to production submit a PR to
main