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:
- 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
Decide on a directory on your computer where you'd like to install Find It. Open a console and navigate to that directory.
rails _4.2.7_ new my_new_blacklight_appto start a new Rails application, which will live in a subdirectory with the name you choose. Replace
my_new_blacklightappwith the name that you chose.
With the text editor of your choice, open the file called
Gemfilein the new subdirectory. Add the line
gem 'blacklight', "~> 6.8"
rails generate blacklight:install --devise --marc --jettywrapper
git initso you can begin using git in this directory.
git remote add findit [URL]where URL is the clone URL for this repository.
git pull findit master
git reset --hard findit/master
bundle installagain to make sure you have all the correct gems installed. You may have to do a few
Open up config/secrets.yml, and add your article_api_username and article_api_password.
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
- Download RailsInstaller: http://railsinstaller.org/en
- 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
- Sign in to GitHub.
- Click "Fork" to make your own working copy of the repo.
- Follow the installation instructions.
- Make your changes.
- 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:
- Download VM software: https://www.virtualbox.org/wiki/Downloads
- Download Ubuntu: https://www.ubuntu.com/download/desktop
- 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)
- 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:
- Open Terminal
sudo apt-get install ruby ruby-dev rails postgresql sqlite3 libsqlite3-dev rake git postgresql-server-dev-all zlib1g-dev liblzma-dev
git clone https://github.com/lbcclib/findit
sudo gem install pg
sudo gem install sqlite3 -v '1.3.13'
rails new -s .
- Open browser (Firefox) and enter 'http://localhost:3000' (the 3000 part may be different, you can search the Terminal message for that)