Git Product home page Git Product logo

reviewme's Introduction

ReviewMe

NPM Version Downloads

ReviewMe is a nodejs app that monitors App Store and Google Play reviews, and posts them to Slack.

ReviewMe Preview

This project was originally forked from reviews-to-slack

Installation

npm install -g @trademe/reviewme

Usage

reviewme ~/myappsconfig.json

Config

ReviewMe requires a config file. A simple config looks something like:

{
  "slackHook": "https://hooks.slack.com/services/01234/5678",
  "verbose": true,
  "dryRun": false,
  "interval":300,
  "apps": [
    {
      "appId": "com.myandroidapp",
      "publisherKey": "~/publisher.json"
    },
    {
      "appId": "012345678",
      "regions": [
              "nz",
              "us"
      ]
    }
  ]
}

Options

  • slackHook: The slack hook for your Slack integration. Reviews will be posted here.
  • verbose: When enabled, log messages will be printed to the console
  • dryRun: When enabled, ReviewMe will post the latest app review for each app on startup. Useful for debugging
  • botIcon An image url to use for the bot avatar
  • showAppIcon Determines if app icon will be displayed (overrides botIcon)
  • channel Overrides the default Slack channel messages will be posted to
  • interval The interval (in seconds) to check for new reviews. Default: 300.
  • apps A list of apps to fetch reviews for. See App Options below
  • publisherKey Android Only The path to a Google Play Publisher private key (.json file). Used for accessing the Google Play Publisher API.

App options

Note: Some options override the global configuration

  • appId The Android app package name, or the iOS app ID.
  • regions iOS Only The ISO 3166-2 regions to fetch reviews for (use false to include all regions)
  • botIcon An image url to use for the bot avatar
  • showAppIcon Determines if app icon will be displayed (overrides botIcon)
  • channel Overrides the default Slack channel messages will be posted to

Google Play Publisher Key

ReviewMe requires access to the Google Play Publisher API to fetch reviews. You need to supply ReviewMe with a Google Play Publisher API private key:

  • Go to the Google Play Developer Console -> Settings -> API Access
  • Create a Google Play Android Developer project
  • Create a Service Account with "Service Accounts" -> "Service Account User" role
  • Download the private key (.json)
  • Supply the path to the private key in the config.json

reviewme's People

Contributors

josh-burton avatar regevbr avatar peterdavehello avatar cooksimo avatar vortec4800 avatar janpapenbrock avatar sparshrestha avatar vipuldelwadiatrademe avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.