|
1 | | -This lesson is known to work with hydra (gem) version 6.1.0, 6.2.0. |
2 | | -_Please update this wiki to reflect any other versions that have been tested._ |
3 | | - |
4 | 1 | # Goals |
5 | 2 | * Add the Hydra software to your application's list of dependencies |
6 | | -* Use bundler to install dependencies |
| 3 | +* Add Hydra (Hydra, Blacklight, and Devise) functionality to your Rails Application |
7 | 4 |
|
8 | 5 | # Explanation |
9 | 6 |
|
10 | 7 | In order to take advantage of the Hydra code and features in your application, you need to tell the application where to find that code and which versions of that code to use. Rails uses a tool called [bundler](http://bundler.io/) to track dependencies. Bundler looks in the file called `Gemfile` to know what you want installed. |
11 | 8 |
|
| 9 | +Hydra builds on and extends the features provided by Blacklight, the hydra generator integrates core hydra and blacklight functionality into your application. To do this, we run the custom [Rails generator](http://guides.rubyonrails.org/generators.html) provided by the hydra gem. The generator creates a number of files in your application that will allow you to build a Hydra application and use and modify Blacklight's features in your application. The default generator also installs [devise](https://github.com/plataformatec/devise) to provide simple user authentication and management. |
| 10 | + |
12 | 11 | # Steps |
13 | 12 |
|
14 | | -Open up ```Gemfile``` in your editor. We're going to add the following lines: |
| 13 | +### Step 1: Add the *hydra* gem to your Gemfile |
| 14 | + |
| 15 | +Open up `Gemfile` in your editor. We're going to add the following lines after the `source` line: |
15 | 16 |
|
16 | 17 | ```ruby |
17 | 18 | gem 'hydra' |
18 | 19 | ``` |
19 | 20 |
|
20 | | -This declares our application to have a dependency on the hydra6 release version of the hydra-gem and ensures that the hydra-head gem gets included (required) correctly. This includes a dependency for the jettywrapper gem (installed automatically). The jettywrapper gem is used to install and configure a preconfigured instance of jetty that loads and runs local development instances of Fedora and Solr for you to run and test your application against. |
| 21 | +This includes the hydra-gem in our application. Bundler will then ensure that the hydra-head, blacklight, active-fedora and other gems required by hydra get included (required) correctly. This includes a dependency for the jettywrapper gem (installed automatically). The jettywrapper gem is used to install and configure a preconfigured instance of jetty that loads and runs local development instances of Fedora and Solr for you to run and test your application against. |
| 22 | + |
| 23 | +Now save the change and install the dependencies by running bundler: |
| 24 | +```text |
| 25 | +bundle install |
| 26 | +``` |
| 27 | + |
| 28 | +Check which files have been changed: |
| 29 | +```text |
| 30 | +git status |
| 31 | +``` |
| 32 | + |
| 33 | +You should see changes to your `Gemfile` and `Gemfile.lock`. Now, go ahead and commit the modified files to your local git repo: |
| 34 | +```text |
| 35 | +git add . |
| 36 | +git commit -m "Add hydra dependency to Gemfile" |
| 37 | +``` |
| 38 | + |
| 39 | +### Step 2: Run the code generator provided by the *hydra* gem. |
| 40 | + |
| 41 | +> |
| 42 | +**Tip:** If you want to see clearly what changes that the generator makes, make sure that all of your current changes have been checked into git before running the generator. I.E. make sure that `git status` reports that there are no changes ("nothing to commit"). Then, after you run the generator, you can list all of the newly created and modified field by running `git status`. |
| 43 | +> |
| 44 | +
|
| 45 | +Run the hydra generator |
| 46 | + |
| 47 | +```text |
| 48 | +rails generate hydra:install |
| 49 | +``` |
| 50 | + |
| 51 | +The hydra generator invokes both the blacklight generator and the hydra-head generator. Additionally, the blacklight generator installed the devise gem and the bootstrap gem. It's created an important file in our application `app/controllers/catalog_controller.rb`. This is the primary place where you configure the blacklight search. |
| 52 | + |
| 53 | +When they are done, the generators have created a few database migrations that support saving user data, searches and bookmarks. Normally you would have to run `rake db:migrate` to update your database tables, but the hydra installer does this for you as one of its last steps. |
| 54 | + |
| 55 | +### Step 3: Review and commit your changes |
| 56 | + |
| 57 | +See what the hydra generator has done |
| 58 | +```text |
| 59 | +git status |
| 60 | +``` |
| 61 | + |
| 62 | +After you've viewed which files have been modified, commit the changes: |
21 | 63 |
|
22 | | -Now we save the file and install the dependencies by running bundler: |
23 | 64 | ```text |
24 | | -$ bundle install |
| 65 | +git add . |
| 66 | +git commit -m "Ran hydra generator" |
25 | 67 | ``` |
26 | 68 |
|
27 | 69 | # Next Step |
28 | | -Go on to [[Lesson: Run the Hydra generator]] or return to the [[Dive into Hydra]] page. |
| 70 | +Go on to [[Lesson: Install hydra-jetty]] or return to the [[Dive into Hydra]] page. |
0 commit comments