https://github.com/sunnysideup/silverstripe-google-analytics-pdf-downloads

https://github.com/sunnysideup/silverstripe-google-analytics-pdf-downloads

Last synced: 21 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sunnysideup/silverstripe-google-analytics-pdf-downloads
• Owner: sunnysideup
• License: other
• Created: 2024-09-18T21:13:43.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-11-07T20:23:55.000Z (about 2 months ago)
• Last Synced: 2024-11-25T08:33:07.919Z (about 1 month ago)
• Language: Scheme
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Track Direct PDF Downloads with Google Analytics

[![Build Status](https://travis-ci.org/sunnysideup/silverstripe-google-analytics-pdf-downloads.svg?branch=master)](https://travis-ci.org/sunnysideup/silverstripe-google-analytics-pdf-downloads)

[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-google-analytics-pdf-downloads/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sunnysideup/silverstripe-google-analytics-pdf-downloads/?branch=master)

[![codecov.io](https://codecov.io/github/sunnysideup/silverstripe-google-analytics-pdf-downloads/coverage.svg?branch=master)](https://codecov.io/github/sunnysideup/silverstripe-google-analytics-pdf-downloads?branch=master)

[![Latest Stable Version](https://poser.pugx.org/sunnysideup/google-analytics-pdf-downloads/version)](https://packagist.org/packages/sunnysideup/google-analytics-pdf-downloads)

[![License](https://poser.pugx.org/sunnysideup/google-analytics-pdf-downloads/license)](https://packagist.org/packages/sunnysideup/google-analytics-pdf-downloads)

[![Monthly Downloads](https://poser.pugx.org/sunnysideup/google-analytics-pdf-downloads/d/monthly)](https://packagist.org/packages/sunnysideup/google-analytics-pdf-downloads)

## Documentation

This module is not compatible with other modules that overwrite the assets/.htaccess file.

After installing, add your google analytics code to your yml config like so:

```yml

---

Name: pdf_analytics

---

Sunnysideup\GAPDFDownloads\PDFDownloadController:

  analytics_code: 'G-0000000'

```

-   [Developer Docs](docs/en/INDEX.md)

-   [User Guide](docs/en/userguide.md)

-   [API Docs](http://docs.ssmods.com/sunnysideup/google-analytics-pdf-downloads/classes.xhtml)

## Requirements

See [composer.json](composer.json) for details.

### Suggested modules

See [composer.json](composer.json) for details.

## Installation

```shell

composer require sunnysideup/google-analytics-pdf-downloads

```

### Configuration

In the `_config` folder you will find the `google-analytics-pdf-downloads.yml.example`

file that shows options for the configuration of this module.

We recommend that you:

1. copy these `google-analytics-pdf-downloads.yml.example` files into your

   `app/_config` folder (where available - otherwise search for `private static $` in the module to see what can be configured)

2. remove the .example extension,

3. delete the lines you do not care about, and

4. adjust the configurations that you would like to use.

## Contributing

We welcome any contributions.

See [CONTRIBUTING.md](CONTRIBUTING.md) for more details.

## Paid assistance

You can pay us to create an improved / adapted version of this module for your own projects.

Please contact us if you like to find out more: [www.sunnysideup.co.nz](https://www.sunnysideup.co.nz).

For example, we can write tests for this module.

## Author

Sunny Side Up Ltd.

## Looking for Silverstripe Modules?

To find other modules, please visit [ssmods.com](https://ssmods.com/).