Winston has a base set of requirements for you to use it.
You can optionally tell Winston whether you'd like to enable machine learning algorithm or not. If it's enabled, Winston performs the following:
Winston installation and setup is comprised of three core parts. Below is an overview of the three parts followed by details on configuring each of the parts.
You need to setup your Winston configuration file settings to your liking and create tests and variations. You can store your configuration settings however you want (array, JSON, Yaml, database, key/val store) so long as you can convert the settings to a properly formatted array when initializing Winston.
Winston requires a fairly lengthy configuration array of settings, tests, and test variations. For a full picture of what a configuration array looks like, check out the basic example config file:
You need to add code to your client facing frontend website to display variations and track performance.
The example below uses short tags, but you don't have to if they aren't enabled. In this example, we're checking to see if varying the page's headline/tagline has any affect on the frequency of clicking a button directly below it.
You need to create a new server side file (a controller route and action if you use MVC) which you grant Winston access to POST data to. There are two specific API endpoints you'll need for Winston which ultimately load an instance of Winston and call the following:
The example below only contains minimal routing support to give you an idea for how to tie in the endpoints from the config file.
Winston supports triggering variation successes for all of the popular DOM events, however we
suggest steering clear of mouse movement events given how frequently they trigger. The full list
of supported events is
keyup. Note that we do not handle
preventing default event actions or stopping propagation. If you need that, add your own additional
event bindings to the element(s).
To trigger an event in your client side code, simply call:
EVENT_TYPE is one of the events mentioned above. This method will then
generate and return a DOM event string for you to output directly in your HTML, i.e.
Let's now bind a form submission event directly to a form as an example which will get attributed to the chosen variation. The order in which you call event() and variation() doesn't matter.
With Winston, you can add event bindings directly within your variation text/html. In each
variation, you can use the syntax
one of the supported client events found in the section above. Winston will internally find and
triggered, the currently selected variation will trigger successfully and an AJAX request will
fire to your backend indicating the success.
Here's an example of a test you can setup in your configuration file which utilizes the basic template engine:
Redis is an in-memory key/value store. It's default configuration is to save snapshots of your data every 60 seconds or every 1000 keys changed. Because of this, you risk data loss if any of the following were to occur:
If you can't tolerate losses of this magnitude and are willing to sacrifice a bit write speed,
you'll want to enable Append-only file data persistence in your redis configuration file. You
can modify your config file, generally found in
Before updating your
redis.conf file, you'll want to first read the guide below to backup your
existing Redis database via an RDB dump to ensure no data is lost during the transition.
You will likely want to increase the default security measures/precautions of your Redis install.
127.0.0.1for the local machine or
192.168.1.Xfor a machine within your same subnet. Likewise, you'll want to edit your redis.conf file and add
bind XXX.XXX.XXX.XXXwith your allowed IP or IPs. If you need remote access, you can use bind
0.0.0.0, but only if you also create firewall rules to whitelist machines and grant them access to port
'auth' => 'yourredispassword'.
Downloads are available via github. The decision is all yours:
git clone [email protected]:popdotco/winston.git
git clone https://github.com/popdotco/winston.git
If you have any problems with GoogleAuthenticatorRedux, please file a ticket/issue/bug on Github and we will attempt to address it at my earliest convenience.Winston Issues on Github
Winston is licensed under the MIT License.
The MIT License is simple and easy to understand and it places almost no restrictions on what you can do with Double Rainbow.
You are free to use Double Rainbow in commercial projects as long as any copyright headers and license file are left intact.