jamesblackwell / laravel-experiments
A server-side A/B testing tool for Laravel.
Requires
- php: >=5.4.0
- illuminate/support: 5.*
- league/csv: ~6.0
- symfony/console: *
Requires (Dev)
This package is not auto-updated.
Last update: 2024-12-21 20:30:34 UTC
README
A server-side A/B testing tool for Laravel, a great free alternative for services such as optimizely. Use A/B testing to figure out which content works, and which doesn't.
This tool allows you to experiment with different variations of your website and tracks what the difference in engagement or reached goals is between them. Whenever you ask the A/B testing class for the current experiment, it will select the next experiment that has the least visits so that every experiment is tested equally. When there is an active experiment going on, it will start tracking engagement (click a different link, or submitting a form) and check if certain defined goals are reached. These goals are generally urls or routes, but can also be triggered manually.
Installation
Require the package
composer require jamesblackwell/laravel-experiments
Add the service provider in app/config/app.php:
'Jamesblackwell\AB\TesterServiceProvider',
Register the AB alias:
'AB' => 'Jamesblackwell\AB\Facades\AB',
Configuration
Publish the included configuration file:
php artisan config:publish jamesblackwell/ab
Next, edit the config/packages/jamesblackwell/ab/config.php file. The following configuration options are available:
Database Connection
This is your Laravel database connection that is used to store the A/B testing data. This is handy when you want to store the A/B testing data in a different database. When empty, it will use your default database connection.
'connection' => 'mysql',
Experiments
These are your A/B experiments. These are unique identifiers that you can use in your code or views to decide which version you should be showing.
'experiments' => [
'big-logo',
'small-buttons',
'short-form'
],
Goals
Without goals, each experiment will track the number of visitors that saw the experiment and detect engagement. Additionally, you can define certain goals that you want to reach with your experiments. If, your main goal is for your visitors to buy your product or contact you for more information, and you have specific routes set up for both of these pages, your goals could look like this:
'goals' => [
'pricing/order',
'contact'
]
Your goals can be relative urls, named routes or can be triggered manually.
Preparing the A/B test database
Once you have selected your database connection, use the included install command to prepare the required tables:
php artisan ab:install
The database structure is small and lightweight, so it will not impact your application.
Usage
After you have defined your experiments and goals, you can start designing your A/B tests. All your visitors will be given the next experiment that has the least visits. You can request the current experiment identifier with the AB::experiment() method. For example, if you have defined the following experiments ['a', 'b', 'c'], your view could look like this:
@if (AB::experiment('a'))
<div class="logo-big"></div>
@elseif (AB::experiment('b'))
<h1>Brand name</h1>
@elseif (AB::experiment('c'))
<div class="logo-greyscale"></div>
@else
// Original or default value
// This maybe appears when experiment has inactive
@endif
Once the visitor is assigned to an experiment, his next clicks are automatically tracked to see if he is engaging with your website or completing certain goals. These goals are relative urls or named routes, and will be marked as completed when a visitor visits that url during an experiment.
NOTE: Visitors are only tracked if you are conducting an experiment. Only when you ask the current AB::experiment(), it will assign an experiment to that user using the current Laravel session.
Adding new experiments
If you want to add new experiments, it may be best to clear the existing A/B testing data with this command:
php artisan ab:flush
If you don't flush your existing experimental data, all new visitors will see the new experiment first until it catches up with the pageviews of the old experiments.
Reports
A/B testing reports are available through an artisan command:
php artisan ab:report
This will generate a simple output containing the results for each experiment and their goals.
+------------+----------+----------------+---------------+---------------+---------------+
| Experiment | Visitors | Engagement | Buy | Contact | Pricing |
+------------+----------+----------------+---------------+---------------+---------------+
| a | 173,074 | 6.0 % (10,363) | 1.3 % (2,249) | 4.8 % (8,307) | 5.3 % (9,172) |
| b | 173,073 | 5.1 % (8,826) | 1.1 % (1,903) | 3.5 % (6,057) | 3.9 % (6,749) |
| c | 173,073 | 5.0 % (8,653) | 1.0 % (1,730) | 1.3 % (5,538) | 3.2 % (5,538) |
+------------+----------+----------------+---------------+---------------+---------------+
You can also export these reports to .csv format using this command:
php artisan ab:export /path/to/file.csv
If you run that command without a filepath, it will write it to the console.
Advanced
AB::pageview()
Used to manually trigger an pageview.
AB::interact()
Used to manually trigger an interaction which results in engagement.
AB::complete($goal)
Used to manually trigger goals. Useful when you want to track goals that are not linked to urls or routes.
AB::getExperiments()
Get the list of experiments.
AB::getGoals()
Get the list of goals.
AB::hasExperiments()
Return true if has more than 1 experiment into table "experiments".
AB::currentExperiment()
Return the name of the current session experiment.
Advanced
Edited and exported to Laravel 5.1 by @rafelsanso