https://github.com/killbill/killbill-analytics-ui
Kill Bill UI for the Analytics plugin
https://github.com/killbill/killbill-analytics-ui
billing killbill payments subscriptions
Last synced: about 1 year ago
JSON representation
Kill Bill UI for the Analytics plugin
- Host: GitHub
- URL: https://github.com/killbill/killbill-analytics-ui
- Owner: killbill
- License: mit
- Created: 2015-01-23T23:56:13.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2024-10-22T03:33:21.000Z (over 1 year ago)
- Last Synced: 2024-10-23T05:28:36.090Z (over 1 year ago)
- Topics: billing, killbill, payments, subscriptions
- Language: Ruby
- Homepage: https://killbill.io
- Size: 466 KB
- Stars: 4
- Watchers: 5
- Forks: 9
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: MIT-LICENSE
Awesome Lists containing this project
README
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 must be running somewhere with the [analytics plugin](https://github.com/killbill/killbill-analytics-plugin)
* Kanaui can be started locally or can be [mounted in a rails app](https://github.com/killbill/killbill-admin-ui-standalone)
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.20.z (Rails 5) |
| 2.1.y | 0.22.z (Rails 5) |
| 2.2.y | 0.24.z (Rails 6) |
| 4.x.y | 0.24.z (Rails 7) |
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
```