An oral history video site and administrative interface packaged as a Rails gem. Uses HTML5 video.
This code was originally part of the Student Leadership Initiative. It has since been extracted and significantly updated and refactored. The codename for the internal project is Sleader, so this project was named Kinney. Sleader-Kinney.
Also now used on the Computer Simulation Archive site.
Update 2017-03-22 Both of these sites have now been converted over to using a static site generator (Middleman), and no known instances of Kinney now exist.
- Rails 4
- Ruby 2.0.0 and 1.9.3
- MySQL, Postgresql, and sqlite3
- Create a fresh Rails application
rails new olympiaand
- Add kinney to your Gemfile:
gem "kinney", "~> 0.1.1"
Or you can use the current master:
gem 'kinney', git: 'https://github.com/jronallo/kinney.git', branch: 'master'
- Add the following other dependencies to your Gemfile:
gem 'font-awesome-sass-rails' gem 'activeadmin', git: 'https://github.com/gregbell/active_admin.git', branch: 'master'
bundle exec rake kinney:install:migrations db:migrate
bundle exec rails generate kinney:installand
- Add a devise secret key to config/initializers/devise.rb. You can create a good new secret to use with
config.secret_key = 'a better secret key than this'
Seed the database:
bundle exec rake db:seed
Add an ExecJS runtime for your environment. In your Gemfile you can uncomment
bundle exec rails cto enter the Rails console and then
Kinney::AdminUser.create!(:email => 'firstname.lastname@example.org', :password => 'password', :password_confirmation => 'password')and
exitto return to your shell.
Start the Rails server (
bundle exec rails s) and go to http://localhost:3000/admin. Login with the credentials above.
Add a Topic.
Add a Person.
Now we need to put some video and related files where kinney can find them. By default video and related assets are served up from your app under /public/media/ directory and images from /public/photos/. (Later we'll see how to override these defaults to use a different asset host.) For now we can just add some dummy data from the kinney gem.
Either check out the kinney code with
git clone https://github.com/jronallo/kinney.gitor find where your installed gem is with
bundle show kinney. From the root of either copy over the directories public/media and public/photos into your own application's public directory.
Add a Clip (currently video only). If you have the dummy data you can add "tolson-roots" as the Filename for a clip. Make this clip a "top pick".
Visit the home page at http://localhost:3000 and you should see the poster for your video. Click on it to go to the video play page. Ensure that the video plays.
Read the following to learn how to configure your new oral history site.
When running the Kinney installation generator several files were created and some of those need to be configured. Many views can also be overridden in your application. Finally, all models and most controllers are implemented as Concerns so it is easy to override specific methods or actions in your application or add new features.
The installer asked you for your application name. Should you ever want to change it you can update the ApplicationHelper#application_name method.
Defines Kinney::Clip#siskel_path which is used in several places to calculate the URL to your HTML5 Video, poster images, and webvtt files. You will definitely want to update this method to reflect where your HTML5 Video is stored. You can change it
Note that this uses the convention of storing all access derivatives for a single video within one directory. Here's an example directory structure.
media ├── atkins-campuslife_fire │ ├── atkins-campuslife_fire.mp4 │ ├── atkins-campuslife_fire.png │ ├── atkins-campuslife_fire.vtt │ └── atkins-campuslife_fire.webm ... └── tolson-roots ├── tolson-roots.mp4 ├── tolson-roots.png ├── tolson-roots-transcript.pdf ├── tolson-roots-transcript.txt ├── tolson-roots.vtt └── tolson-roots.webm
If your videos do not follow this convention, then you may have to override other methods of a Kinney::Clip like png, mp4, webm, and vtt to provide a correct URL.
- Kinney::Clip#png is used for video poster image URLs.
- Kinney::Clip#mp4 and Kinney::Clip#webm are used for the video URLs. Currently to cover the most modern browsers you'll want to create both MP4 and WebM access copies of your video.
- Kinney::Clip#vtt is for WebVTT captioning if available.
When overriding these methods you have the flexibility to use whatever you enter into the filename field to determine the final URL however you would like. You might follow a similar convention with filenaming and placement, but have them on another host. Or you could just use the information to connect to a database to retrieve the URL.
Instead of adding these media files to your application and placing them under version control, an initial simple step you may consider is to keep this simple structure and the defaults in place and using symlinks for these directories.
This file is generated so that the image model can have an #external_url method. This allows you to link out from an image modal to the original image where you might have more information about the resource.
See below for helpers that can be used for changing image tags. For instace we use Djatoka to dynamically serve up squared, cropped images.
Routes are generated for the admin interface, login, mounting the kinney engine, and setting the application root.
You may want to change where kinney is mounted to be at the root of your application:
mount Kinney::Engine => "/", :as => 'kinney'
Or at some other mount point:
mount Kinney::Engine => "/oral-histories", :as => 'kinney'
This can allow you to have a kinney oral history project inside another Rails application.
You may also want to change the root of your application to point to your own application's home page.
You may have to restart your server for this change to show up.
You may want to
Google Analytics in config/application.rb
Update the generated google analytics id to turn on page and event tracking.
In order for the mailer within the devise authentication system to work you will need to configure the mailer for each environment under config/environments/.
If you haven't already please add the secret_key to config/initializers/devise.rb.
In config/initializers/devise.rb add
config.mailer_sender = 'email@example.com'
Views to Override
Every view template within the public portion of the site can be overridden. You'll want to override all of the following views. Most of these are noted within the interface so should be obvious where they effect the display. In some cases you may just want to include a blank template.
These will need to be overridden to change the Sleater-Kinney orange that shows up above the main navbar. These partials allow for customing the brand of the site.
If you need to have some kind of other large header on your home page, this is the file to update.
You probably want more in your footer than just about and contact links.
Both the _about_text and _contact partials show up on the about page and will need to be overridden in your own application.
Many other views
Look through the kinney source code for other views you may want to override. In some cases small portions of the page have been broken out into partials to make this easier without a lot of copying.
Look under the kinney gem's app/helpers/kinney/ directory for helpers you may want to override.
The index view for clips (http://localhost:3002/kinney/videos) has two different views available. You can select which partial you would like to use by overriding this helper.
- clips_grouped_by_person is good for when each person has several short clips. This view avoids having the same head show up too many times.
- all_clips shows each individual clip. This means that if a person is in more than one interview they will show up more than once on the page.
The public interface uses Bootstrap 3 converted into Sass. You can use Sass variables to customize the appearance of the site. Consult the Bootstrap customication documentation for which variables are available.
The gem uses the Rails Internationalization API to allow for translations. This also makes it easy to use config/locales/en.yml to override some of the headings and other test that shows on the page. You'll definitely want to change the key
If you have a good translation that could be used as the default for a language other than English, please let me know.
bundle exec rake kinney:reindex will reindex in elasticsearch.
bundle exec rake test
Running the Dummy App
You may need to drop the ElasticSearch index at time:
bundle exec rake environment app:tire:index:drop INDEX=kinney\_dummy_development
Then you need to go into the dummy directory to start the app:
cd test/dummy bundle exec rails s