Partner Metrics provides useful revenue metrics of your app, theme and affiliate revenue generated from the Shopify Partner Program.
GPL-3.0 License
Partner Metrics is an open-source project providing you with metrics of your app, theme and affiliate revenue from the Shopify Partner program. Currently it calculates metrics based on monthly and yearly subscriptions, one-time charges and usage charges from Shopify.
This project is not officially related to Shopify in any way.
Partner Metrics was created by @forsbergplustwo, and will remain free to use at:
The app in this repo was recently upgraded to Rails 7. If you had the earlier version running locally, you can upgrade by performing the following actions on your existing local app:
bin/rails db:migrate
bin/rails db:encryption:init
bin/rails create_initial_imports
bin/rails migrate_partner_api_credentials
Note: We recommend deleting your existing metrics data and re-importing to take advantage of improvements to churn calculations + yearly subscriptions support.
bin/setup
bin/dev
Visit localhost:4000
To run tests:
bin/rails test
# including system tests
bin/rails test:all
To import data from Partner API manually (once you have added your credentials in the app UI):
bin/rails import_all_from_partner_api
config/credentials/production.yml.enc
bin/rails credentials:edit -e production
and update as necessaryheroku config:set RAILS_MASTER_KEY=[key]
where [key]
is the value of your config/credentials/production.key
file.bin/rails import_all_from_partner_api
on a daily basis.We'd love for you to contribute join us in making it better! In general, please follow the "fork-and-pull" Git workflow.
standardrb --fix
to safely-autofix any linter or formatter correctionsWe have a handful of MiniTests and Fixtures in the codebase, and welcome more. Please write MiniTests for new code you create.
Everyone interacting in Partner Metrics repository is expected to follow the Code of Conduct.
Partner Metrics is released under the GPLv3 License.