{"id":21820314,"url":"https://github.com/trademe/reviewme","last_synced_at":"2025-04-06T02:07:17.021Z","repository":{"id":23941462,"uuid":"100202770","full_name":"TradeMe/ReviewMe","owner":"TradeMe","description":"Google Play and App Store reviews posted to Slack","archived":false,"fork":false,"pushed_at":"2024-05-30T08:05:31.000Z","size":360,"stargazers_count":183,"open_issues_count":14,"forks_count":53,"subscribers_count":14,"default_branch":"master","last_synced_at":"2025-04-01T17:02:14.782Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/TradeMe.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-08-13T20:28:07.000Z","updated_at":"2025-02-11T15:46:13.000Z","dependencies_parsed_at":"2024-11-27T16:46:46.360Z","dependency_job_id":null,"html_url":"https://github.com/TradeMe/ReviewMe","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TradeMe%2FReviewMe","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TradeMe%2FReviewMe/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TradeMe%2FReviewMe/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TradeMe%2FReviewMe/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TradeMe","download_url":"https://codeload.github.com/TradeMe/ReviewMe/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247423512,"owners_count":20936626,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-27T16:31:18.136Z","updated_at":"2025-04-06T02:07:17.002Z","avatar_url":"https://github.com/TradeMe.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# ReviewMe\n\n![NPM Version](https://img.shields.io/npm/v/@trademe/reviewme.svg) ![Downloads](https://img.shields.io/npm/dt/@trademe/reviewme.svg)  \n\nReviewMe is a nodejs app that monitors App Store and Google Play reviews, and posts them to Slack.\n\n![ReviewMe Preview](images/reviewme-preview.png)\n\nThis project was originally forked from [reviews-to-slack](https://www.npmjs.com/package/reviews-to-slack)\n\n\n## Installation\n\n`npm install -g @trademe/reviewme`\n\n## Usage\n\n`reviewme ~/myappsconfig.json`\n\n## Config\n\nReviewMe requires a config file. A simple config looks something like:\n\n```json\n{\n  \"slackHook\": \"https://hooks.slack.com/services/01234/5678\",\n  \"verbose\": true,\n  \"dryRun\": false,\n  \"interval\":300,\n  \"apps\": [\n    {\n      \"appId\": \"com.myandroidapp\",\n      \"publisherKey\": \"~/publisher.json\"\n    },\n    {\n      \"appId\": \"012345678\",\n      \"regions\": [\n              \"nz\",\n              \"us\"\n      ]\n    }\n  ]\n}\n```\n### Options\n* **slackHook**: The slack hook for your Slack integration. Reviews will be posted here.\n* **verbose**: When enabled, log messages will be printed to the console\n* **dryRun**: When enabled, ReviewMe will post the latest app review for each app on startup. Useful for debugging\n* **botIcon** An image url to use for the bot avatar\n* **showAppIcon** Determines if app icon will be displayed (overrides botIcon)\n* **channel** Overrides the default Slack channel messages will be posted to\n* **interval** The interval (in seconds) to check for new reviews. Default: `300`.\n* **apps** A list of apps to fetch reviews for. See App Options below\n* **publisherKey** *Android Only* The path to a Google Play Publisher private key (`.json` file). Used for accessing the Google Play Publisher API.\n\n### App options\nNote: Some options override the global configuration\n\n* **appId** The Android app package name, or the iOS app ID.\n* **regions** *iOS Only* The [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2#Current_codes) regions to fetch reviews for (use `false` to include all regions)\n* **botIcon** An image url to use for the bot avatar\n* **showAppIcon** Determines if app icon will be displayed (overrides botIcon)\n* **channel** Overrides the default Slack channel messages will be posted to\n\n\n## Google Play Publisher Key\nReviewMe requires access to the Google Play Publisher API to fetch reviews. You need to supply ReviewMe with a Google Play Publisher API private key:\n\n* Go to the Google Play Developer Console -\u003e Settings -\u003e API Access\n* Create a Google Play Android Developer project\n* Create a Service Account with \"Service Accounts\" -\u003e \"Service Account User\" role\n* Download the private key (`.json`)\n* Supply the path to the private key in the `config.json`\n\n \n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrademe%2Freviewme","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftrademe%2Freviewme","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftrademe%2Freviewme/lists"}