Abraham

screenshot of Abraham

Trackable application tours for Rails with i18n support

Overview

Abraham is an innovative gem designed for Ruby on Rails applications, simplifying the process of creating guided tours for users. With its intuitive approach, Abraham gives developers the tools to enhance user experience by providing step-by-step navigations through the features of their applications. Not only does it help new users understand your app better, but it also tracks individual user progress, ensuring that tours are personalized and never repetitive.

What sets Abraham apart is its flexibility in defining tours, which can be tailored for different user segments and in multiple languages. This ensures that your guided tours are relevant and accessible to a diverse user base, helping to improve usability and engagement in any Rails app.

Features

  • User Tracking: Keeps track of user interactions with tours, showing them only when necessary, which helps avoid user fatigue and enhances their experience.
  • Simple YAML Configuration: Define tour content using easy-to-manage YAML files, allowing customization for various languages to cater to global users.
  • Automatic and Manual Triggers: Tours can be initiated automatically on page load or manually activated via JavaScript, providing flexibility based on user needs.
  • Built with Shepherd JS: Leveraging the Shepherd JS library ensures a modern and responsive design for tours, ensuring compatibility and a smooth experience.
  • CSS Theme Options: Ships with two basic themes (default and dark) and the option to create custom styles, allowing for aesthetic consistency with your app's branding.
  • Easy Installation: Simple steps to add Abraham to your project, including adding it to your Gemfile and integrating JavaScript and CSS dependencies.
  • Multi-language Support: Ability to define tours that can cater to different languages, perfect for applications with a diverse user set.
  • Step Configurations: Detailed control over the structure of each tour step, including customizable buttons and placement options, making each tour unique and user-friendly.