/partner-metrics

Partner Metrics provides useful revenue metrics of your app, theme and affiliate revenue generated from the Shopify Partner Program.

Primary LanguageRubyGNU General Public License v3.0GPL-3.0

Partner Metrics

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.

Usage

Partner Metrics was created by @forsbergplustwo, and will remain free to use at:

https://partnermetrics.io

Development

Upgrading

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.

First time setup

  1. Setup dependencies, environment & database: bin/setup
  2. Start web server and sidekiq workers with: 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

Deploying to Production

  1. Delete config/credentials/production.yml.enc
  2. Run bin/rails credentials:edit -e production and update as necessary
  3. If deploying to Heroku, make sure to set heroku config:set RAILS_MASTER_KEY=[key] where [key] is the value of your config/credentials/production.key file.
  4. Setup a cron job to run bin/rails import_all_from_partner_api on a daily basis.

Contributing

We'd love for you to contribute join us in making it better! In general, please follow the "fork-and-pull" Git workflow.

  1. Check out the Issues page, feel free to pick an existing issue or add a new one with clear title and description.
  2. Fork and clone the repo on GitHub
  3. Create a new branch for your fix or code improvement
  4. Run standardrb --fix to safely-autofix any linter or formatter corrections
  5. Commit changes to your own branch
  6. Push your work back up to your fork
  7. Submit a Pull request so that @forsbergplustwo can review your changes. Please link your PR to the existing issue if you are solving one.

Testing

We have a handful of MiniTests and Fixtures in the codebase, and welcome more. Please write MiniTests for new code you create.

Code of Conduct

Everyone interacting in Partner Metrics repository is expected to follow the Code of Conduct.

License

Partner Metrics is released under the GPLv3 License.