History

Philipp Rothmann fb2b4d8a8a chore: rubocop chore: fix api test conventions chore: rubocop -A spec/ chore: more rubocop -A fix failing test rubocop fixes removes helper methods that are in my opinion dead code more rubocop fixes rubocop -a --auto-gen-config		2023-06-09 17:35:05 +02:00
..
lib	chore: rubocop	2023-06-09 17:35:05 +02:00
foodsoft_uservoice.gemspec	chore: rubocop	2023-06-09 17:35:05 +02:00
README.md	Add uservoice plugin	2014-12-16 22:43:46 +01:00

README.md

FoodsoftUservoice

Adds uservoice feedback form to foodsoft.

Configuration

This plugin is configured in the foodcoop configuration in foodsoft's "config/app_config.yml":

  uservoice:

    # find the api key in your uservoice admin settings
    api_key: Abc1234DefGhIjkl567MnoPQr

    # https://developer.uservoice.com/docs/widgets/options/
    set:
      accent_color: '#448dd6'
      trigger_color: white
      trigger_background_color: rgba(46, 49, 51, 0.6)
    addTrigger:
      mode: contact
      trigger_position: bottom-left

    # Tell uservoice about the current user; only keys listed will be sent,
    # when id, email, name or created_at has an empty value, get them from
    # the current user.
    identify:
      id:
      #email:
      #name:
      created_at:
      #type: ExampleFoodcoopType

This plugin also introduces the foodcoop config option use_uservoice, which can be set to false to disable uservoice integration. May be useful in multicoop deployments.

This plugin is currently missing a configuration screen.

See also the uservoice-widget documentation.