Bookends

Shared footer (and eventually header) for Heroku properties.

Requirements

Bookends assumes the presence of:

• jQuery

Installation

Add this line to your application's Gemfile:

gem 'bookends', group: :development

And then execute:

$ bundle

Usage

$ bookends install

Sites using bookends

Please make sure the owners of the following properties are apprised of changes to bookends:

• www
• blog
• engineering
• elements

Development

Spin up

After checking out the repo, run bin/setup to install dependencies. Then, run rake to run the tests.

Install and release

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

See all rake tasks with rake -T

Testing it in an app locally

Rails version

1. gem 'bookends', path: 'path/to/local/copy in the Rails application's Gemfile
2. bundle install from the Rails application
3. bookends install from the Rails application
4. boot up the Rails application
5. If you make changes to Bookends's templates, make sure to run the installer from step 3.

Jekyll version

1. gem install bookends --local ../bookends/pkg/bookends-<latest_pkg> from the root of the Jekyll project.
   • Run rake build from bookends if there are no *.gem files in bookends/pkg/
2. bundle install from the Jekyll application
3. bookends install from the Jekyll application
4. boot up the Jekyll application
5. If you make changes to Bookends's templates, make sure to run the installer from step 3.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/heroku/bookends.