Skip to content

Latest commit

 

History

History
72 lines (50 loc) · 1.88 KB

README.md

File metadata and controls

72 lines (50 loc) · 1.88 KB
Raw

Helpdesk Code Climate Build Status Gem Version

Helpdesk is a Rails engine that provides simple helpdesk functionality directly into your site.

Demo

http://helpdesk-demo.herokuapp.com

Source of demo: https://github.com/wacaw/helpdesk-demo.

Installation

1. Install helpdesk gem

In your Gemfile, add the following dependencies: In Rails 3, add this to your Gemfile and run the +bundle+ command.

gem "helpdesk", '0.0.14'

In Rails 4.1, add this to your Gemfile and run the +bundle+ command.

gem "helpdesk", ">= 0.0.42"

2. Run installation/or migration if updated

rails g helpdesk:install

for update only

rake helpdesk:install:migrations

That creates a Helpdesk initializer and copy locale files to your application.

3. Add 3 methods to your applications application_controller.rb

  • helpdesk_user - to exposes your current_user
  • helpdesk_admin? - to check privileges
  • helpdesk_admins_collection - to list all admin

Example, for app with devise&rolify gems:

class ApplicationController < ActionController::Base
[...]
      helper_method :helpdesk_user,:helpdesk_admin?,:helpdesk_admin_collection
      def helpdesk_user
        current_user
      end

      def helpdesk_admin?
        current_user.has_role? :admin
      end

      def helpdesk_admin_collection
        (Helpdesk.user_class).with_role(:admin)
      end
end

4. Restart app

and visit http://0.0.0.0:3000/helpdesk

License

MIT