HelpStack


Source link: https://github.com/happyfoxinc/helpstack-android

HelpStack is a library to provide in-app support for your app's users, by connecting with the helpdesk of your choice. Your app’s users can easily raise requests or report issues from within your app.

With HelpStack, you can:

  • Let users report issues within your app, along with device & app information
  • Provide self-support by showing FAQ articles
  • Customise your HelpStack screen to blend with your app theme

HelpStack supports the following leading helpdesk solutions:

  • HappyFox
  • Zendesk
  • Desk.com
  • Email - If you don't have a helpdesk solution, you can still configure HelpStack for users to raise requests via email.

You can choose any 1 of the 4 options mentioned above, to get started with HelpStack.

Check out helpstack.io for more information.

How to progress with HelpStack

Checkout this wiki page if you want a clear idea on how you can progress with HelpStack: Wiki - How to progress with HelpStack

App Showcase

Have you made something awesome with HelpStack? Add yourself here: App Showcase

Installation

Installing the HelpStack library is fairly straight-forward.

  1. Add jcenter as a repository to your app's build.gradle

     repositories {
    
     jcenter()  
    }
     
  2. Add com.tenmiles:helpstack:1.2.0 as a dependency in the same build.gradle

     dependencies {
    
     compile 'com.tenmiles:helpstack:1.2.0'  
    }
     
  3. Add this to avoid duplicate file during packaging APK

     packagingOptions {
    
     exclude 'META-INF/DEPENDENCIES'
    
     exclude 'META-INF/NOTICE'
    
     exclude 'META-INF/LICENSE'  
    }
     

For more information on installation, such as Installing in Eclipse and common installation errors, visit this Wiki page: Installation Instructions

Using the Library

Broadly speaking, there are just 3 steps to begin using HelpStack within your app:

The helpdesk solutions will be referred to as Gears.

  1. Configure HelpStack to work with the Gear of your choice.
  2. Add an entry-point for HelpStack in the UI and connect it with HelpStack.
  3. Customize the theme of HelpStack according to your choice.

Step 1 - Configure HelpStack with the Gear of your choice:

Create a custom Application class which extends the Application class. Be sure to mention it in your manifest as well.

<application
android:name="HSApplication"
... />
  

Obtain the necessary credentials for the gear of your choice and create a suitable Gear object. Set the Gear object with HSHelpStack instance only once.

Setting the Gear

The general structure of setting a gear is given below:

public class HSApplication extends Application {

HSHelpStack helpStack;

@Override
public void onCreate() {

  super.onCreate();

 helpStack = HSHelpStack.getInstance(this);
 // Get the HSHelpStack instance

 <GearType> <gear> = new <GearType>(<Gear credentials as parameters>);
 // Create the Gear object

 helpStack.setGear(<gear>);
 // Set the Gear

}
 
}
 

Follow the instructions below for configuring the gear of your choice:

Step 2 - Entry point in UI:

Add a clickable item (probably a button) in your UI, wherever appropriate. Set a click listener to it. Within the click listener, use the showHelp API to open up the HelpStack UI:

HSHelpStack.getInstance(getActivity()).showHelp(getActivity());
 

Step 3 - Theming/Skinning:

It is very easy to customize the HelpStack UI, if you want it go along with your app's UI.

HelpStack comes with built-in screens and a default theme. It also comes with a set of pre-configured themes. You can download them from the link below:

Download Themes

Each theme comes with the following:

  • A colors.xml and a hs_custom_theme.xml defined in ../values/
  • Chat bubble drawables defined in ../drawables/.
Using the sample themes
  • Decide which sample theme you want to use
  • Include the theme and colors xml files in your application under values
  • Include the theme's drawables under your application's drawables
  • Now you can simply build and run the application. The HelpStack UI will use the styles specified in the chosen theme.

List of parameters for configuring the look and feel of HelpStack: Parameters for configuring Themes

Main List View

Issue Details View

Note

If you want the complete look-and-feel of a theme, you might also want to update the color of your app's Action bar.

For more information, refer to the documents in the Wiki section.

External Dependencies

HelpStack depends on the following libraries:

'com.android.support:appcompat-v7:23.0.0' 'com.google.code.gson:gson:2.3' 'org.apache.httpcomponents:httpmime:4.2.6' 'com.mcxiaoke.volley:library:1.0.19' 

Proguard (Optional)

If you have Proguard enabled, please add this snippet to your proguard rules file (eg proguard-rules.pro, proguard.cfg or others):


 # helpstack
  -dontwarn com.polites.**
  -dontwarn com.tenmiles.helpstack.**
  -dontwarn org.apache.commons.**
  -keep class org.apache.http.** {
 *; 
}

  -dontwarn org.apache.http.** 

Video

About

For more information about HelpStack, visit helpstack.io.

HelpStack is maintained by the folks at HappyFox. Being an open source project, it also contains work from the HelpStack community.

Contact

Reach out to us on Twitter at @HelpStackSDK.

License

HelpStack is available under the MIT license. See the LICENSE file for more info.

Resources

A simple view to show different states (empty, loading, etc.).

The Intellij plugin that manages Android colors. It makes easy to browse colors.

An elegant pull-to-refresh control.

A custom radio button for Android.

The project is intended for comparing different revisions of image with other revisions.

Reactive Event Hub.

Topics


2D Engines   3D Engines   9-Patch   Action Bars   Activities   ADB   Advertisements   Analytics   Animations   ANR   AOP   API   APK   APT   Architecture   Audio   Autocomplete   Background Processing   Backward Compatibility   Badges   Bar Codes   Benchmarking   Bitmaps   Bluetooth   Blur Effects   Bread Crumbs   BRMS   Browser Extensions   Build Systems   Bundles   Buttons   Caching   Camera   Canvas   Cards   Carousels   Changelog   Checkboxes   Cloud Storages   Color Analysis   Color Pickers   Colors   Comet/Push   Compass Sensors   Conferences   Content Providers   Continuous Integration   Crash Reports   Credit Cards   Credits   CSV   Curl/Flip   Data Binding   Data Generators   Data Structures   Database   Database Browsers   Date &   Debugging   Decompilers   Deep Links   Dependency Injections   Design   Design Patterns   Dex   Dialogs   Distributed Computing   Distribution Platforms   Download Managers   Drawables   Emoji   Emulators   EPUB   Equalizers &   Event Buses   Exception Handling   Face Recognition   Feedback &   File System   File/Directory   Fingerprint   Floating Action   Fonts   Forms   Fragments   FRP   FSM   Functional Programming   Gamepads   Games   Geocaching   Gestures   GIF   Glow Pad   Gradle Plugins   Graphics   Grid Views   Highlighting   HTML   HTTP Mocking   Icons   IDE   IDE Plugins   Image Croppers   Image Loaders   Image Pickers   Image Processing   Image Views   Instrumentation   Intents   Job Schedulers   JSON   Keyboard   Kotlin   Layouts   Library Demos   List View   List Views   Localization   Location   Lock Patterns   Logcat   Logging   Mails   Maps   Markdown   Mathematics   Maven Plugins   MBaaS   Media   Menus   Messaging   MIME   Mobile Web   Native Image   Navigation   NDK   Networking   NFC   NoSQL   Number Pickers   OAuth   Object Mocking   OCR Engines   OpenGL   ORM   Other Pickers   Parallax List   Parcelables   Particle Systems   Password Inputs   PDF   Permissions   Physics Engines   Platforms   Plugin Frameworks   Preferences   Progress Indicators   ProGuard   Properties   Protocol Buffer   Pull To   Purchases   Push/Pull   QR Codes   Quick Return   Radio Buttons   Range Bars   Ratings   Recycler Views   Resources   REST   Ripple Effects   RSS   Screenshots   Scripting   Scroll Views   SDK   Search Inputs   Security   Sensors   Services   Showcase Views   Signatures   Sliding Panels   Snackbars   SOAP   Social Networks   Spannable   Spinners   Splash Screens   SSH   Static Analysis   Status Bars   Styling   SVG   System   Tags   Task Managers   TDD &   Template Engines   Testing   Testing Tools   Text Formatting   Text Views   Text Watchers   Text-to   Toasts   Toolkits For   Tools   Tooltips   Trainings   TV   Twitter   Updaters   USB   User Stories   Utils   Validation   Video   View Adapters   View Pagers   Views   Watch Face   Wearable Data   Wearables   Weather   Web Tools   Web Views   WebRTC   WebSockets   Wheel Widgets   Wi-Fi   Widgets   Windows   Wizards   XML   XMPP   YAML   ZIP Codes