1.0.0 • Published 8 years ago

alooma-js v1.0.0

Weekly downloads
3
License
Apache-2.0
Repository
github
Last release
8 years ago

Alooma JavaScript Library

The Alooma JavaScript Library is a set of methods attached to a global Alooma object intended to be used by websites wishing to send data to Alooma projects. A full reference is available here.

Alternative installation via Bower

alooma-js is also available via front-end package manager Bower. After installing Bower, fetch into your project's bower_components dir with:

bower install alooma

Using Bower to load the snippet

You can then load the lib via the embed code (snippet) with a script reference:

<script src="bower_components/alooma/alooma-jslib-snippet.min.js"></script>

which loads the latest library version from the Alooma CDN (http://cdn.alooma.com/libs/alooma-latest.min.js).

Using Bower to load the entire library

If you wish to load the specific version downloaded in your Bower package, there are two options.

1) Override the CDN library location with the global ALOOMA_CUSTOM_LIB_URL var:

<script>
  window.ALOOMA_CUSTOM_LIB_URL = 'bower_components/alooma/alooma.js';
</script>
<script src="bower_components/alooma/alooma-jslib-snippet.min.js"></script>

or

2) Recompile the snippet with a custom ALOOMA_LIB_URL using Closure Compiler:

java -jar compiler.jar --js alooma-jslib-snippet.js --js_output_file alooma-jslib-snippet.min.js --compilation_level ADVANCED_OPTIMIZATIONS --define='ALOOMA_LIB_URL="bower_components/alooma/alooma.js"'

Running tests

  • Install development dependencies: npm install
  • Start test server: npm start
  • Browse to http://localhost:3000/tests/ and choose a scenario to run

In the future we plan to automate the last step with a headless browser to streamline development (although Alooma production releases are tested against a large matrix of browsers and operating systems).

1.0.0

8 years ago