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
bundlerto 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.
#For Rails 6 Users
There is nothing additional to note - everything is configured automatically with a specific Webpack
#For Rails 5 Users - Changes made to application.js
When the theme is installed, the following takes place automatically:
jquery-railsis added back into your Gemfile and bundled
//= require jqueryis added to
//= require rrtis added to
So on a fresh new Rails project your
application.jswill end up looking like:
#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 can cause any Gem to act strangely if it's not been installed and configured properly. A common problem is that people often install
bundlerbefore 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
bundlerand re-install it after having installed RVM - and everything will now be installed where RVM can see it.