https://github.com/forsbergplustwo/partner-metrics
Partner Metrics provides useful revenue metrics of your app, theme and affiliate revenue generated from the Shopify Partner Program.
https://github.com/forsbergplustwo/partner-metrics
metrics-visualization rails ruby ruby-on-rails shopify-api shopify-apps
Last synced: 7 months ago
JSON representation
Partner Metrics provides useful revenue metrics of your app, theme and affiliate revenue generated from the Shopify Partner Program.
- Host: GitHub
- URL: https://github.com/forsbergplustwo/partner-metrics
- Owner: forsbergplustwo
- License: gpl-3.0
- Created: 2017-04-15T21:52:21.000Z (about 9 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T10:37:27.000Z (almost 2 years ago)
- Last Synced: 2025-02-14T19:55:45.469Z (over 1 year ago)
- Topics: metrics-visualization, rails, ruby, ruby-on-rails, shopify-api, shopify-apps
- Language: Ruby
- Homepage: https://partnermetrics.io
- Size: 5.44 MB
- Stars: 58
- Watchers: 3
- Forks: 14
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-shopify - partner-metrics - Metrics Dashboard for Shopify Partners, on Rails. ⚠️ (Example Apps / Ruby Examples)
README
# 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](@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:
```bash
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):
```bash
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](https://github.com/forsbergplustwo/partner-metrics-saas/blob/main/CODE_OF_CONDUCT.md).
## License
Partner Metrics is released under the [GPLv3 License](https://github.com/forsbergplustwo/partner-metrics-saas/blob/main/LICENSE.md).