https://github.com/alecperkins/gauges-events
Gauges custom events tracker (unofficial)
https://github.com/alecperkins/gauges-events
Last synced: 2 months ago
JSON representation
Gauges custom events tracker (unofficial)
- Host: GitHub
- URL: https://github.com/alecperkins/gauges-events
- Owner: alecperkins
- License: mit
- Created: 2014-02-11T00:28:21.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-02-11T00:44:10.000Z (over 11 years ago)
- Last Synced: 2024-04-14T03:56:15.650Z (about 1 year ago)
- Language: CoffeeScript
- Homepage: http://get.gaug.es
- Size: 110 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
## Usage
Add the `gaugesevents.min.js` at the bottom of your page.
It will automatically look for links with the `data-gauges-event` attribute:
### ☝ Teh mighty result ☟
### Custom triggering
```html
GaugesEvents.trackEvent('Ads|Apple|Click')
GaugesEvents.trackEvent('[Contact page] vcard download')
GaugesEvents.trackEvent('Contact: Submit form')
```
That’s it!\*
It really *is* that simple. It creates an iframe and tells it to navigate to `/gauges?event=EVENT` where `EVENT` is exactly the `data-gauges-event` attribute value. Said value can be anything, it is totally up to you to make your own pattern.
\* Okay, you do need some — very very basic — server setup.
## Server settings example (Sinatra)
```rb
get '/gauges' do
%(
#{params[:event]}
var _gauges = _gauges || [];
(function() {
var t = document.createElement('script');
t.type = 'text/javascript';
t.async = true;
t.id = 'gauges-tracker';
t.setAttribute('data-site-id', 'YOUR-GAUGES-ID');
t.src = '//secure.gaug.es/track.js';
var s = document.getElementsByTagName('script')[0];
s.parentNode.insertBefore(t, s);
})();
)
end
```
Don’t forget to edit `YOUR-GAUGES-ID`
## Compiling & Minifying
[Yes, the source is in CoffeeScript](http://vimeo.com/35258313)
### Development
If you have no clue how to manually compile CoffeeScript, I’d suggest a tool like [CodeKit](http://incident57.com/codekit/) or [LiveReload](http://livereload.com).
Personally (when in a non-sprockets friendly environment) I simply use [this handy TextMate command](https://gist.github.com/3422110).
### Production version
```sh
$ bundle install
$ rake compile
```
## Mucho thanks
[@rafBM](https://github.com/rafBM) - ([#1](https://github.com/EtienneLem/gauges-events/pull/1), [#2](https://github.com/EtienneLem/gauges-events/pull/2), [#3](https://github.com/EtienneLem/gauges-events/pull/3))
## License
Copyright (c) 2012 Etienne Lemay [email protected], [@EtienneLem](https://twitter.com/EtienneLem)
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.