Ahoy

How to use Ahoy

Ahoy is a Ruby on Rails gem that is used for tracking visits and events in a Rails application. Here are the steps to use Ahoy:

1. Add Ahoy gem to your Gemfile:

gem 'ahoy_matey'

1. Run bundle install to install the gem.
2. Generate the Ahoy migrations:

rails generate ahoy:install
rails db:migrate

1. Set up Ahoy in your application controller:

class ApplicationController < ActionController::Base
  include Ahoy::Tracker

  # customize all ahoy requests with any data you need
  before_action :set_ahoy_user

  private

  def set_ahoy_user
    ahoy.authenticate(user) if user_signed_in?
    ahoy.track_visit
  end
end

1. Track events by calling
   ahoy.track
   method, for example when user clicks a button:

class UsersController < ApplicationController
  def update
    @user = User.find(params[:id])
    if @user.update(user_params)
      ahoy.track "Updated User", {id: @user.id, email: @user.email}
      redirect_to @user
    else
      render 'edit'
    end
  end
end

1. To view the results of the tracked visits and events, Ahoy provides a dashboard that can be mounted into your Rails application. You can add the following line to your
   routes.rb
   file:

mount Ahoy::Engine => "/ahoy"

1. Visit
   /ahoy
   in your browser to see the Ahoy dashboard.

That's it! With Ahoy, you can easily track visits and events in your Rails application and gain insights about how users interact with your application.