FeedbackSPL

Please note that this is a prototype under development. It is not thought to use in a production environment yet.

Requirements for contributors and feedback apps developers

• Pure::variants v5.0: Our SPL is build on top of pure::variants. Pure::variants is an eclipse plugin for development and deployment of products lines and software families.
  • Evaluation Software to develop it.
• NodeJS v12: required to compile the resultant generated products. We recommend you to use nvm for UNIX-like systems or for windows to manage multiple versions of nodeJS installed in your system.
• Gulp v4: a javascript toolkit to manage build tasks over nodeJS. To install it globally run: npm install -g gulp

How to create and test your Feedback app

Step 1. You can create a product variant in ./Variants/ folder in Eclipse. Configure with the features that your feedback app must have to conduct your annotation activity.

Step 2. Generate the product, the resultant will be placed in ./output/<name_of_your_product>

Step 3. Resolve dependencies and compile:

• In windows systems: Open a powershell and execute in ./output/<name_of_your_product> folder: ./dependencies.ps1
• In UNIX-like systems: Open a shell and execute in ./output/<name_of_your_product> folder: ./dependencies.sh

Step 4. A compiled browser extension is created in ./output/<name_of_your_product>/dist folder. Drag and drop to your browser's extensions folder (remember that Developer mode must be activated)

Step 5. Test the installed extension in the browser

Examples

We have created two variants that can be used as an example:

• ReviewAndGo
• MetaReviewAndGo

Continuous delivery for application engineers

Each of the derived products from WacLine are ready to build, test and pack to delivery in browser extensions stores (e.g: Chrome Web Store). Here are described some gulp tasks to facilitate these activities:

Build

Note that ./dependencies.sh or ./dependencies.ps1 described above builts the browser extension to install as a developer in chrome. The following section describes other available options for building.

$ gulp

Option	Description
--watch	Starts a livereload server and watches all assets. To reload the extension on change include livereload.js in your bundle.
--production	Minifies all assets
--verbose	Log additional data to the console.
--vendor	Compile the extension for different vendors (chrome, firefox, opera, edge) Default: chrome
--sourcemaps	Force the creation of sourcemaps. Default: !production

Pack

Zips your dist directory and saves it in the packages directory.

$ gulp pack --vendor=firefox

Testing

We are currently planning to automatize web annotation clients testing using puppeteer.