https://github.com/philipwalton/analyticsjs-boilerplate

Examples and best practices for using analytics.js
https://github.com/philipwalton/analyticsjs-boilerplate

Last synced: 3 days ago
JSON representation

Examples and best practices for using analytics.js

• Host: GitHub
• URL: https://github.com/philipwalton/analyticsjs-boilerplate
• Owner: philipwalton
• License: isc
• Created: 2017-02-01T17:41:52.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-09-09T18:10:53.000Z (over 7 years ago)
• Last Synced: 2024-11-12T23:03:36.527Z (about 1 month ago)
• Language: JavaScript
• Size: 45.9 KB
• Stars: 1,128
• Watchers: 53
• Forks: 58
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# analytics.js boilerplate

Best practices for implementing analytics.js on modern websites.

For an in-depth explanation of all the features used in this boilerplate (as well as how to report on them), see my article:

[**The Google Analytics Setup I Use on Every Site I Build**](https://philipwalton.com/articles/the-google-analytics-setup-i-use-on-every-site-i-build/) →

## Boilerplate versions

### [`analytics/base.js`](/src/analytics/base.js)

The base boilerplate extends the [default tracking snippet](https://developers.google.com/analytics/devguides/collection/analyticsjs/#alternative_async_tracking_snippet) and includes the following features:

- Tracks uncaught errors.

- Tracks custom user, session, and hit-level dimensions.

- Sends an initial pageview.

- Sends a pageload performance event.

### [`analytics/autotrack.js`](/src/analytics/autotrack.js)

The autotrack boilerplate builds on top the base boilerplate and includes [select autotrack plugins](https://philipwalton.com/articles/the-google-analytics-setup-i-use-on-every-site-i-build/#using-autotrack-plugins)

### [`analytics/multiple-trackers.js`](/src/analytics/multiple-trackers.js)

The multiple-trackers boilerplate builds on the autotrack boilerplate and includes support for using [multiple trackers](https://philipwalton.com/articles/the-google-analytics-setup-i-use-on-every-site-i-build/#testing-your-implementation).

## Running the boilerplate locally

analytics.js boilerplate uses [webpack](https://webpack.js.org/) to compile the source and [webpack-dev-server](https://github.com/webpack/webpack-dev-server) to run it locally.

To install the dependencies and load the boilerplate in a browser, run the following commands:

```sh

npm install

npm start

```

Then visit [localhost:8080](http://localhost:8080) in your browser and open the developer console to see the analytics.js debug output.

### Running different boilerplate versions

The boilerplate [`index.js`](/src/index.js#L7) JavaScript file imports the base boilerplate by default. To run a different version, replace the URL imported via `import('./analytics/base.js')` with the version you want to load.