No release in over a year
Bootstrap Feedbacker opens a modal window for users to send application feedback over email that includes the referring url.
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Runtime

>= 6.0.0
 Project Readme

Gem Version Code Climate

BootstrapFeedbacker

BootstrapFeedbacker provides a modal form to collect user feedback and sends it in an email including the current page URL to the configured email address.

Requirements

  • Rails 6.0 or higher with Import Maps, Turbo Frames, and Stimulus
  • Bootstrap version 4
  • User model with an email attribute
  • current_user method defined in ApplicationController

Installation

  1. Add the bootstrap_feedbacker gem to your Gemfile:
gem "bootstrap_feedbacker"
  1. Run bundle install.

  2. Run rails bootstrap_feedbacker:install:migrations.

  3. Run rails db:migrate to add the bootstrap_feedbacker_remarks table to your schema.

  4. Mount the engine in your routes.rb file:

mount BootstrapFeedbacker::Engine, at: '/bootstrap_feedbacker'
  1. Add the bootstrap feedbacker link and modal container to a view file:
<%= bootstrap_feedbacker_link %>
<%= bootstrap_feedbacker_modal %>

Configure

Create config/initializersbootstrap_feedbacker.rb and set your email address:

BootstrapFeedbacker::SETTINGS.email_to = 'support@yourdomain.com'

Or set your email address and override any of these default settings:

  BootstrapFeedbacker::SETTINGS.update do |settings|
    settings.email_to           = 'support@yourdomain.com'
    settings.email_prefix       = '[FEEDBACKER]'                              # default
    settings.modal_content_id   = 'bootstrap_feedbacker_remark_modal_content' # default
    settings.modal_id           = 'bootstrap_feedbacker_remark_modal'         # default
    settings.user_class         = 'User'                                      # default
    settings.user_name_method   = :name                                       # default
  end

License

Bootstrap Feedbacker is released under the MIT License.