[THIS IS NOT MASTER] Helpy is a modern, "mobile-first" helpdesk application built in Ruby. Features include multi-lingual knowledgebase, community discussions and private tickets integrated with email.
Ruby HTML CSS JavaScript
Pull request Compare This branch is 30 commits behind helpyio:master.
Latest commit 4c94cd2 Jan 17, 2017 @scott committed on GitHub Update readme
Permalink
Failed to load latest commit information.
app Merge pull request #489 from helpyio/dev/add-channel-and-phone Jan 17, 2017
bin Clean up and add additional endpoints Jun 14, 2016
config Merge branch 'master' into dev/add-channel-and-phone Jan 17, 2017
db Merge branch 'master' into feature/add-channel-and-phone Jan 3, 2017
docs Docs: Basic setup guide Feb 26, 2016
lib Fix 2 email related bugs Jan 13, 2017
log First commit on road to Rails 4.2 compatibility Mar 16, 2015
public Use dynamic 404 and 500 Error pages Sep 2, 2016
test Merge branch 'master' into dev/add-channel-and-phone Jan 17, 2017
vendor/assets Move Mousetrap to own lib Dec 31, 2016
.bowerrc . Apr 22, 2015
.byebug_history Change controller and view Oct 16, 2016
.codeclimate.yml Exclude themes from codeclimate check Jun 30, 2016
.eslintignore Added code climate scripts Mar 10, 2016
.eslintrc Added code climate scripts Mar 10, 2016
.gitignore Install Carrierwave and JQ upload Oct 13, 2016
.hound.yml Tune hound configuration Apr 11, 2016
.rubocop.yml Enable Style/AndOr cop Oct 10, 2016
.scss-lint.yml ScssLint: Resolve SelectorFormat violations Mar 11, 2016
.travis.yml Revert "Relax required Ruby version" Jan 14, 2017
Gemfile Revert "Relax required Ruby version" Jan 14, 2017
Gemfile.lock Update Carrierwave to 1.0.0. Jan 4, 2017
HEROKU.md Prepare for 1.1.0 release Nov 28, 2016
LICENSE Update copyrights Jul 28, 2016
Procfile Revert "minot changes for flynn JIK" Jul 21, 2016
README.md Update readme Jan 17, 2017
Rakefile First commit on road to Rails 4.2 compatibility Mar 16, 2015
app.json Update refs to scott/helpy Mar 12, 2016
bower.json moved bower repos into vendor, install icon picker plugin Apr 22, 2015
config.ru First commit on road to Rails 4.2 compatibility Mar 16, 2015

README.md

Helpy: A Modern Helpdesk Alternative

Helpy is a modern, "mobile first" helpdesk solution written in Ruby on Rails 4.2 and released under the MIT license. The goal of Helpy is to provide an open source alternative to commercial helpdesk solutions like Zendesk or desk.com

Build Status Code Climate

Features

Helpy is an integrated support solution- combining and leveraging synergies between support ticketing, Knowledgebase and a public community. Each feature is optional however, and can be easily disabled.

  • Multichannel ticketing: Integrated with inbound email via Sendgrid, Mandrill, Mailgun, etc.
  • Knowledgebase: Full text searchable and SEO optimized to help users answer questions before they contact you.
  • Pre-wired for Google Analytics: Using a combination of JS and Measurement Protocol tags, Helpy is prewired to track everything from article satisfaction to what your agents are doing.
  • Mobile-first: Support requests come at all times, and Helpy works on all devices out of the box so you can delight customers with prompt answers, from anywhere and at anytime!
  • Community Support Forums: Customers and Agents can both answer questions in a publicly accessible forum.
  • Voting: Discussion topics and replies support voting.
  • Embed Widget: Helpy Includes a lightweight javascript widget that allows your users to contact you from just about anywhere.
  • Multi-lingual: Helpy is fully multi-lingual and can provide support in multiple languages at the same time. Currently the app includes translations for 19 languages and is easy to translate.
  • Themeable: Customize the look and functionality of your Helpy without disturbing the underlying system that makes it all work. Helpy comes with two additional themes, and we hope to add more and get more from the community as time goes on.

Hosting

We offer a hosted version of Helpy for businesses that don't want to worry about self installing and maintaining their Helpy. You can get an instant free trial of the hosted version to see if Helpy is right for you: Test it Out for Free

Live Demo

There is also a live demo with fake data available at http://demo.helpy.io Admin User: admin@test.com and password: 12345678

Installation

Helpy was designed to run on on modern cloud providers, although it should work on any linux based system. There is a full guide to installing Helpy at http://support.helpy.io/en/knowledgebase/11-installing-helpy

Requirements are:

  • Ruby 2.2+
  • Rails 4.2.x
  • Postgres
  • A server like Unicorn, Puma or Passenger

Helpy leverages two external services to help out:

  • an email provider like Sendgrid
  • Google Analytics for stats (optional)

Getting Started:

Install Helpy on your Local System

Although not required, installing locally is highly recommended and will make it easier for you to customize things like settings, colors and logos to match your site identity. To begin, clone Helpy from the official repo to your local system:

git clone https://github.com/helpyio/helpy.git

Configure Basic Settings

There is a settings option in the admin panel to set up things like i18n, system names, colors, the embeddable widget, etc. There is a full guide to getting set up at: Configuring Your Helpy Settings

Support Multiple Languages (optional)

Helpy includes support for Multilingual help sites, and multi-language knowledgebase articles. This page explains how to enable Helpy's international capabilities and provides an overview of what functionality this adds to Helpy: How To Set Up A Multilingual Helpy Support Knowledgebase

Set up your Helpy to send and receive email (optional)

Helpy has the ability to receive email at your support email addresses and import the messages as tickets in the web interface. Whenever you or the user replies to the email thread, Helpy captures the discussion and sends out messages accordingly. Follow the tutorial on Setting Up Your Helpy Installation To Send And Receive Email to set this up.

Configure oAuth (optional)

Helpy supports Omniauth login capabilities. This means you can allow your support users to sign in with a single click via any Omniauth provider- ie. Facebook, Twitter, Gmail, or many others. Read Setting Up Oauth For Your Helpy to see how.

Contributing

Welcome, and thanks for contributing to Helpy. Together we are building the best customer support platform in the world. Here are some of the ways you can contribute:

  • Report or fix Bugs
  • Refactoring
  • Improve test coverage- As with any large and growing codebase, test coverage is not always as good as it could be. Help improving test coverage is always welcome and will help you learn how Helpy works. We use Minitest exclusively.
  • Translate the project- The community has already translated Helpy into 18 languages, but there are many more waiting. We need help getting Helpy translated into as many locales as possible! please see the guide to translation
  • Build new features. There is a backlog of new features that we’d like to see built. Check out our roadmap for more insight on this, and if you would like to take one on, please get in touch with us to make sure someone is not already working on it.

General Guidelines:

  • Join us on Slack. Let me know you wish to contribute. Slack Status
  • Make your PRs granular. They should only include one piece of functionality per PR.
  • Check the roadmap: Trello If you want to build a feature, contact us to make sure no one else is already working on it
  • You must provide passing test coverage. We use minitest, see http://www.rubypigeon.com/posts/minitest-cheat-sheet/?utm_source=rubyweekly&utm_medium=email
  • You also must expose functionality to the API. We use Grape. API methods should be tested as well.
  • If your feature/bug fix/enhancement adds or changes text in the project, please create i18n strings in en.yml and any other locales you can.
  • We are hugely concerned with user experience, and a nice UI. Oftentimes that means we may take what you have contributed and “dress it up” or as you to do the same.

License

Copyright 2017, Helpy.io, LLC, Scott Miller and Contributors. Helpy is released under the MIT open source license. Please contribute back any enhancements you make. Also, I would appreciate if you kept the "powered by Helpy" blurb in the footer. This helps me keep track of how many are using Helpy.

Analytics