Find It -- LBCC's blacklight-based discovery layer
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
config
db/migrate
jetty
lib/tasks
public
spec
test
.travis.yml
Gemfile
LICENSE
README.md
Rakefile

README.md

Find It

Build Status Coverage Status security

Find It is a discovery layer for Linn-Benton Community College's library. This tool searches across most of the library's print and electronic resources so that students don't get stuck in just one silo of information.

Find It is based on Blacklight, with a few other gems thrown in. This repository represents the changes we made from a basic installation of blacklight.

In theory, you should be able to get this to work on Windows and Linux boxes using Ruby or JRuby, but has only been tested in the following environments:

  • JRuby on Windows Server 2013
  • Ruby on Ubuntu 15.10 and 16.10

Installing Find It

Here's how to get this running for yourself:

  1. Make sure that Ruby, Rails, Git, and Java are installed on your computer.
  • For folks running Linux, the OpenJDK version of Java should be sufficient; I haven't needed to use Oracle Java for this setup.
  • For folks running Windows, install JRuby, then run the command gem install rails -v 4.2.7. Also download and install Git
  1. Decide on a directory on your computer where you'd like to install Find It. Open a console and navigate to that directory.

  2. Type rails _4.2.7_ new my_new_blacklight_app to start a new Rails application, which will live in a subdirectory with the name you choose. Replace my_new_blacklightapp with the name that you chose.

  3. With the text editor of your choice, open the file called Gemfile in the new subdirectory. Add the line gem 'blacklight', "~> 6.8"

  4. Run bundle install

  5. Run rails generate blacklight:install --devise --marc --jettywrapper

  6. Run git init so you can begin using git in this directory.

  7. git remote add findit [URL] where URL is the clone URL for this repository.

  8. git pull findit master

  9. git reset --hard findit/master

  10. bundle install again to make sure you have all the correct gems installed. You may have to do a few bundle update commands.

  11. rake db:migrate

  12. Open up config/secrets.yml, and add your article_api_username and article_api_password.

  13. You may also need to add the following three lines to app/config/initializers/assets.rb:

Rails.application.config.assets.precompile += %w( icons/* )
Rails.application.config.assets.precompile += %w( blacklight/findit.png )
Rails.application.config.assets.precompile += %w( *.png )

Adventurous Installation for Windows

  1. Download RailsInstaller: http://railsinstaller.org/en
  2. Download Postgres: http://www.enterprisedb.com/products/pgdownload.do#windows
gem install bundle
git clone https://github.com/lbcclib/findit -b rails_5
cd findit
bundle install
rake db:migrate

Then, go ahead and edit config/articles.yml and config/database.yml.

Contributing to this software

  1. Sign in to GitHub.
  2. Click "Fork" to make your own working copy of the repo.
  3. Follow the installation instructions.
  4. Make your changes.
  5. Submit a pull request to get your changes incorporated. This sounds complicated, but it's actually pretty simple:
  • Go to your forked repository.
  • Click the pull requests tab
  • Click New Pull Request.
  • Verify your changes, then click "Create pull request".

Ben's Adventurous-ish Installation Guide (Using an Ubuntu VM)

Setting up Virtual Machine:

  1. Download VM software: https://www.virtualbox.org/wiki/Downloads
  2. Download Ubuntu: https://www.ubuntu.com/download/desktop
  3. Click 'New' in VM -> Name it -> select 'Linux' for type -> continue with default RAM memory allocation -> Create virtual hard disk -> select VDI (default) -> select Dynamically Allocated for hard disk space -> important: choose 11gb, (for some reason, the default is not enough)
  4. Start the Virtual Machine you just created -> click the folder to browse system for an OS image. -> Find the Ubuntu OS image you downloaded in step 2 (in Downloads folder by default) -> 'Install Ubuntu' -> check 'Download updates while installing Ubuntu' -> 'Erase disck and install Ubuntu' -> 'Install Now' -> 'Continue' -> select time-zone -> select keyboard -> name machine -> give password -> 'Continue' -> wait... ->

After Virtual Machine is set up:

  1. Open Terminal
  2. sudo apt-get install ruby ruby-dev rails postgresql sqlite3 libsqlite3-dev rake git postgresql-server-dev-all zlib1g-dev liblzma-dev
  3. git clone https://github.com/lbcclib/findit
  4. cd findit
  5. sudo gem install pg
  6. sudo gem install sqlite3 -v '1.3.13'
  7. bundle install
  8. rails new -s .
  9. rake findit:install
  10. rails server
  11. Open browser (Firefox) and enter 'http://localhost:3000' (the 3000 part may be different, you can search the Terminal message for that)