Skip to content

logui-framework/client

Repository files navigation

LogUI Client

Welcome to LogUI! LogUI is a powerful, framework-agnostic client-side JavaScript library that can be used for logging interactions that take place on a webpage. Primarily designed for Interactive Information Retrieval (IIR) experiments, LogUI can in theory be used on any page or site that you wish to track fine-grained user interactions with UI components.

Use the LogUI client in tandem with the LogUI server. You can find the LogUI server living at this repository.

About LogUI

The LogUI library is implemented by Dr David Maxwell, a postdoctoral researcher at TUDelft in the Netherlands. It has been developed in the Lambda Lab, headed by Dr Claudia Hauff. The library is borne out of the need for infrastructure that allows one to undertake the logging of user interactions in a consistent way, rather than the piecemeal approach that we've seen in IIR experimentation.

We think that a one-size-fits-all logging library is just the ticket for your experiments!

Using LogUI in Experiments?

We're thrilled that you're using LogUI in your experiments! We ask that in return you provide due credit for this work. If you have a paper associated with your experiment, please do cite the associated demonstration paper that was published at ECIR 2021. You can find the BibTeX source for the paper below.

@inproceedings{maxwell2021logui,
    author = {Maxwell, David and Hauff, Claudia},
    title ="{LogUI: Contemporary Logging Infrastructure for Web-Based Experiments}",
    booktitle = {Advances in Information Retrieval (Proc. ECIR)},
    year = {2021},
    pages = {525--530},
}

Documentation and Quick Start Guide

For documentation on the LogUI client library, please go and check the corresponding Wiki associated with this repository. There, you'll find detailed information about how to acquire yourself a copy, how to set the client library up, how to integrate it with your existing application's code, and information which should allow you to gain a better understanding as to the thinking behind the library's implementation.

Tests

Tests are being developed for the LogUI client library and will be available in this repository soon.

Found a Bug or have a Feature Request?

It would be great to hear from you! Please raise an issue in this repository and we can discuss what options that can be pursued to resolve it.