FiveUI is an extensible tool for evaluating HTML user interfaces against sets of codified UI Guidelines.
Installation and getting started
FiveUI is a basic browser extension with support for Firefox and Google Chrome. If you're familiar with browser extensions, you can quickly install FiveUI from the binaries:
The Installation Guide describes the installation process for Firefox and Google Chrome.
After you've installed FiveUI, take a look at the Getting Started Guide to learn about Rule Sets and setting URL Patterns to match web sites to codified guidelines.
Most (if not all) the FiveUI dependencies are included in the repository, so building FiveUI should be as simple as running:
The default target will stage both extensions into the
build/firefox directories, respectively. To build the packaged extensions,
$ make package
Chrome signing key
In order to build the Google Chrome extension, you will need to first place a
signing key in the top level directory with the name
fiveui.pem. It isn't
necessary to do this in order to build and use the Chrome extension locally
Using the Chrome Extension Unpacked below).
Using the Chrome Extension Unpacked
Chrome Extentions FAQ
on how to load an unpacked extension using "Developer mode". You should use the
build/chrome/ directory for this.
Running the Firefox Extension Unpacked
The build system provides a
run-firefox target that will make sure that the
staged extension is up to date, and then execute the
cfx run command in the
$ make run-firefox
Running the tests
make test target depends on:
- a virtual framebuffer (xvfb-run)
- Mozilla Firefox
- a Java runtime
- Apache Maven
If those are installed, then you should be able to run the test target from the top-level directory with:
$ make test
If this fails to work on your system, please let us know so we can make the testing process more robust.
Testing without xvfb
Getting a virtual framebuffer (xvfb) working on OS X is tough. You can still
run the Maven tests manually by going to
src/batchtools and running:
$ mvn test
Beware that multiple browser instances will spawn in the process. The maven test
reports are by default written to the various
This is the repository for the FiveUI project.
binaries : A directory holding the latest extension binaries doc : FiveUI Documentation exampleData : Sample web pages and rule sets for testing. mk : Build system utilities profiles : Sample user profiles for web browsers. Used for testing. src : Project source code tools : Third-party build tools