Gem Version Build Status

C80FeedbackForm

Gem adds functionality to allow users to send feedback messages from site.

Installation

Add this line to your application's Gemfile:

gem 'c80_feedback_form'

And then execute:

$ bundle

Or install it yourself as:

$ gem install c80_feedback_form

Usage

NOTE: This gem uses activeadmin gem, jQuery gem, bootstrap-sass gem and c80_modal_forms gem.

Ensure, that your application's Gemfile contains these lines:

# active admin
gem 'activeadmin'
gem 'devise'
gem 'cancan' # or cancancan
gem 'draper'
gem 'pundit'

gem 'jquery-rails'
gem 'bootstrap-sass'
gem 'c80_modal_forms'

You will need to add these lines into your application.js:

//= require bootstrap/modal
//= require c80_modal_form
//= require c80_feedback_form

And add this line into application.scss:

@import "bootstrap-sprockets";
@import "bootstrap";
@import "c80_feedback_form";

Add this line into active_admin.scss:

@import "active_admin_c80_feedback_form";

Add this line into routes.rb:

mount C80FeedbackForm::Engine => '/'

Gem functionality applies to code snippets like this:

<body id="contacts"> <!-- js script performs at body#contacts page only -->
   <...>
   <div id="ff"></div> <!-- feedback form placeholder -->
   <...>
</body>

Development

After checking out the repo, run bin/setup to install dependencies. Then, run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release to create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

  1. Fork it ( https://github.com/[my-github-username]/c80_feedback_form/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request