radu-gheorghe / psulib_blacklight

Project for Penn State Library's Blacklight Catalog.

Setup Your Environment

Mac

• Get homebrew installed and configured using these instructions from DSRD until step 12
• ruby via rbenv (Upgrading Ruby Version Using rbenv)

Dependencies

Software	Version
ruby	2.5.3 (ruby 2.5.3p105 (2018-10-18 revision 65156) [x86_64-darwin16])
rails	5.2.1
solr	7.4.0

Development Setup

1. Make sure you have ssh keys established on your machine

2. Make sure you have docker installed and running

3. Clone the application and install:

   git clone [e-mail]:psu-libraries/psulib_blacklight.git
   cd psulib_blacklight
   bundle install --without production test
   

4. Create the database and run the migrations

   bundle exec rake db:create db:migrate
   

5. Start the application

   bundle exec foreman start -f Procfile.dev
   

   Note: on a Mac you may be asked by the OS if you want to allow incoming connections to Ruby. Because this is a local dev instance, you can choose to deny incoming connections. This configuration can be found in the Security & Privacy section of the Systems Preferences.

Indexing

Use Traject

To clean out data that is being preserved explicitly run:

bundle exec rails docker:clean

Go to http://localhost:3000/catalog.

Building and Using Javascript

Follow the instructions for How To Use Webpacker to compile javascript assets.