89 lines
4 KiB
Markdown
89 lines
4 KiB
Markdown
|
# JavaScript web analytics for Snowplow
|
||
|
|
|
||
|
|
[![Build Status][travis-image]][travis]
|
||
|
|
[![Selenium Test Status][saucelabs-button-image]][saucelabs]
|
||
|
|
[![Code Climate][codeclimate-image]][codeclimate]
|
||
|
|
[![Built with Grunt][grunt-image]][grunt]
|
||
|
|
[![License][license-image]][bsd]
|
||
|
|
[](https://www.jsdelivr.com/package/gh/snowplow/snowplow-javascript-tracker)
|
||
|
|
|
||
|
|
## Overview
|
||
|
|
|
||
|
|
Add analytics to your websites and web apps with the [Snowplow][snowplow] event tracker for
|
||
|
|
JavaScript.
|
||
|
|
|
||
|
|
With this tracker you can collect user event data (page views, e-commerce transactions etc) from the
|
||
|
|
client-side tier of your websites and web apps.
|
||
|
|
|
||
|
|
## Find out more
|
||
|
|
|
||
|
|
| Technical Docs | Setup Guide | Roadmap & Contributing |
|
||
|
|
|-------------------------------------|------------------------------|--------------------------------------|
|
||
|
|
| [![i1][techdocs-image]][tech-docs] | [ ![i2][setup-image]][setup] | ![i3][roadmap-image] |
|
||
|
|
| [Technical Docs][tech-docs] | [Setup Guide][setup] | _coming soon_ |
|
||
|
|
|
||
|
|
|
||
|
|
## Developers
|
||
|
|
|
||
|
|
### Contributing quickstart
|
||
|
|
|
||
|
|
Assuming git, [Vagrant][vagrant-install] and [VirtualBox][virtualbox-install] installed:
|
||
|
|
|
||
|
|
```
|
||
|
|
host$ git clone https://github.com/snowplow/snowplow-javascript-tracker.git
|
||
|
|
host$ cd snowplow-javascript-tracker
|
||
|
|
host$ vagrant up && vagrant ssh
|
||
|
|
guest$ cd /vagrant
|
||
|
|
guest$ sudo npm install
|
||
|
|
guest$ cd core
|
||
|
|
guest$ sudo npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
Set up an `./aws.json` file using the example `./aws.sample.json`. If you just want to concat +
|
||
|
|
minify without uploading then you don't need to fill out the `aws.json` file with valid credentials.
|
||
|
|
|
||
|
|
Build the package (default task concatenates and minifies) using `grunt`.
|
||
|
|
|
||
|
|
## Testing
|
||
|
|
|
||
|
|
[![Selenium Test Status][saucelabs-matrix-image]][saucelabs]
|
||
|
|
|
||
|
|
## Copyright and license
|
||
|
|
|
||
|
|
The Snowplow JavaScript Tracker is based on Anthon Pang's [`piwik.js`][piwikjs], the JavaScript
|
||
|
|
tracker for the open-source [Piwik][piwik] project, and is distributed under the same license
|
||
|
|
([Simplified BSD][bsd]).
|
||
|
|
|
||
|
|
Significant portions of the Snowplow JavaScript Tracker copyright 2010 Anthon Pang. Remainder
|
||
|
|
copyright 2012-14 Snowplow Analytics Ltd.
|
||
|
|
|
||
|
|
Licensed under the [Simplified BSD][bsd] license.
|
||
|
|
|
||
|
|
[snowplow]: http://snowplowanalytics.com/
|
||
|
|
|
||
|
|
[vagrant-install]: http://docs.vagrantup.com/v2/installation/index.html
|
||
|
|
[virtualbox-install]: https://www.virtualbox.org/wiki/Downloads
|
||
|
|
|
||
|
|
[piwik]: http://piwik.org/
|
||
|
|
[piwikjs]: https://github.com/piwik/piwik/blob/master/js/piwik.js
|
||
|
|
[piwikphp]: https://github.com/piwik/piwik/blob/master/piwik.php
|
||
|
|
[bsd]: http://www.opensource.org/licenses/bsd-license.php
|
||
|
|
[integrating]: /snowplow/snowplow/blob/master/docs/03_integrating_snowplowjs.md
|
||
|
|
[selfhosting]: /snowplow/snowplow/blob/master/docs/04_selfhosting_snowplow.md
|
||
|
|
[setup]: https://github.com/snowplow/snowplow/wiki/javascript-tracker-setup
|
||
|
|
[integrating-js-on-website]: https://github.com/snowplow/snowplow/wiki/integrating-javascript-tags-onto-your-website
|
||
|
|
[tech-docs]: https://github.com/snowplow/snowplow/wiki/javascript-tracker
|
||
|
|
[techdocs-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/techdocs.png
|
||
|
|
[setup-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/setup.png
|
||
|
|
[roadmap-image]: https://d3i6fms1cm1j0i.cloudfront.net/github/images/roadmap.png
|
||
|
|
[grunt-image]: https://cdn.gruntjs.com/builtwith.png
|
||
|
|
[grunt]: http://gruntjs.com/
|
||
|
|
[travis-image]: https://travis-ci.org/snowplow/snowplow-javascript-tracker.png?branch=master
|
||
|
|
[travis]: http://travis-ci.org/snowplow/snowplow-javascript-tracker
|
||
|
|
[codeclimate-image]: https://codeclimate.com/github/snowplow/snowplow-javascript-tracker.png
|
||
|
|
[codeclimate]: https://codeclimate.com/github/snowplow/snowplow-javascript-tracker
|
||
|
|
[saucelabs]: https://saucelabs.com/u/snowplow
|
||
|
|
[saucelabs-button-image]: https://saucelabs.com/buildstatus/snowplow
|
||
|
|
[saucelabs-matrix-image]: https://saucelabs.com/browser-matrix/snowplow.svg
|
||
|
|
[license-image]: http://img.shields.io/badge/license-simplified--bsd-blue.svg?style=flat
|