Rails mountable engine to offer an analytics dashboard
Ruby JavaScript HTML CSS Shell
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
app
bin
config
lib
script
test
vendor/assets/javascripts
.gitignore
.travis-install-dependencies.sh
.travis.yml
Gemfile
MIT-LICENSE
README.md
Rakefile
kanaui.gemspec

README.md

Overview

Kanaui stands for Kill Bill Analytics UI. This is a mountable rails engine which allows to view the analytics dashboard. In order to work correctly:

Kill Bill compatibility

Kanaui version Kill Bill version
0.4.y 0.16.z
0.5.y 0.18.z (Rails 4)
0.6.y 0.18.z (Rails 5)
1.x.y 0.19.z

Getting Started

You can run Kanaui locally by using the test/dummy app provided and interracting with a running version of Kill Bill along with the analytics plugin. In that mode, there is no support for authorization and no support for multi-tenancy. Instead, Kanaui will use the default user admin:password and rely on static configuration to provide the tenant apiKey and apiSecret.

Kanaui Configuration

Specify your Kill Bill server url, api key and secret in test/dummy/config/initializers/killbill_client.rb:

KillBillClient.url = 'http://127.0.0.1:8080/'
KillBillClient.api_key = 'bob'
KillBillClient.api_secret = 'lazar'

Testing

To run the dummy app:

rails s

To run tests:

rails t