KISO Docs

Installation

#Overview

On the Order Page, you'll find a code snippet that you just need to paste into your Gemfile, and run bundle install, and you'll be good to go! The snippet looks like this:
Protect your credentials.
The credentials given to configure Bundler are unique to you. Do not open source them, or the theme any way.
source "https://gems.kiso.io/" do
  gem "kiso_themes", "~> 1.0.0"
end
This snippet is just an example. Yours may look differently based on your license. Login to your Account and copy your snippet from there.
You'll then configure bundler to use credentials when accessing that source, and you're all done!
If you're using Heroku, you need to set a special Environment variable as well, by running this on the command line:
heroku config:set BUNDLE_GEMS__KISO__IO=<YOUR_CREDENTIALS_GO_HERE>
All of this is shown with your credentials on your Account page.

#Rails 5 - Changes made to application.js

When the theme is installed, the following takes place automatically:
  • jquery-rails is added back into your Gemfile and bundled
  • //= require jquery is added to application.js
  • //= require rrt is added to application.js - this is the main entry point for all of Rapid Rails Themes Javascript - do not remove it.
Beware of //= require_tree .
Be aware that require_tree does not provide any guarantees about the order in which files are loaded. You may inadvertently end up loading some javascript files before others which are dependent, causing errors.
So on a fresh new Rails project your application.js will end up looking like:
// This is a manifest file that'll be compiled into application.js, which will include all the files
// listed below.
//
// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, or any plugin's
// vendor/assets/javascripts directory can be referenced here using a relative path.
//
// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
// compiled file. JavaScript code in this file should be added after the last require_* statement.
//
// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
// about supported directives.
//

//= require jquery
//= require rails-ujs
//= require turbolinks
//= require kiso_themes
//= require_tree .

#Vendoring the Theme

It is possible to vendor the KISO Themes gem locally into your project. Be aware that if you chose to do this you will not receive automatic updates or upgrades.
To vendor the KISO Themes gem locally, execute the following command:
gem unpack kiso_themes --target vendor/gems
You would then update your Gemfile to point to the vendor path, making sure to substitute the version number you end up vendoring into the path:
gem 'kiso_themes', 'VERSION_NUMBER_GOES_HERE', path: "vendor/gems/kiso_themes-VERSION-OF-GEM-VENDORED-GOES-HERE"

#RVM Issues

RVM can cause any Gem to act strangely if it's not been installed and configured properly. A common problem is that people often install bundler before they configure and install RVM, which leads to Gems sometimes being placed where RVM can't see them. The solution in this case is to uninstall bundler and re-install it after having installed RVM - and everything will now be installed where RVM can see it.