https://github.com/b3none/gdprconsent

A super flexible GDPR compliance / GDPR consent solution which, if implemented correctly, will make your site GDPR compliant.
https://github.com/b3none/gdprconsent

gdpr gdpr-consent gdpr-plugin gdprconsent

Last synced: 12 months ago
JSON representation

A super flexible GDPR compliance / GDPR consent solution which, if implemented correctly, will make your site GDPR compliant.

• Host: GitHub
• URL: https://github.com/b3none/gdprconsent
• Owner: B3none
• License: mit
• Created: 2019-03-28T20:13:54.000Z (over 7 years ago)
• Default Branch: development
• Last Pushed: 2023-12-24T17:28:54.000Z (over 2 years ago)
• Last Synced: 2024-05-29T22:47:50.003Z (about 2 years ago)
• Topics: gdpr, gdpr-consent, gdpr-plugin, gdprconsent
• Language: JavaScript
• Homepage: https://github.com/b3none
• Size: 268 KB
• Stars: 9
• Watchers: 4
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# GDPR Consent

A super flexible GDPR consent solution that, if implemented correctly, will make your site GDPR compliant.

What can you tell me about GDPR? [This blog post](https://www.wired.co.uk/article/what-is-gdpr-uk-eu-legislation-compliance-summary-fines-2018) does an exceptional job at explaining it.

## User Disclaimer

The current version, `1.0.0`, is the initial proof of concept and is subject to substantial change. As such we recommend that you watch the repository for releases:

![Watch for releases](.github/README_ASSETS/watch_releases.png)

## Installation

To install this project you will need to include the following code before all other scripts get loaded. If you do not do this then your site will not be able to be fully GDPR compliant as we cannot prevent other scripts from executing.

```html

    // TODO: Implement config:

    // https://github.com/b3none/gdprconsent#customisable-settings

    window.gdprconsent = {};

```

You should also include our default stylesheet using the following snippet:

```html

```

#### *OR*

If the use of CDNs really isn't your style then please download the [latest release](https://github.com/b3none/gdprconsent/releases/latest) and replace the CDN urls with your own hosted version.

## Customisable settings

This project allows you to specify custom settings.

To declare these settings you need to put a script tag above the library include containing the following:

```html

  window.gdprconsent = {

    services: [

      {

        storage_key: '<ANY_KEY_YOU_WANT>',

        title: '<TITLE_IN_SIDEBAR>',

        disable: function() {

          // Callback used to disable the functionality

        },

        enable: function() {

          // Callback to enable the functionality

        },

      }

    ]

  };

```

## Contributions

We're happy to accept contributions so long as you're open to constructive criticism! Nobody is perfect!

## Versioning

We use [SemVer](http://semver.org/). For the versions available, see the [tags on this repository](https://github.com/b3none/gdprconsent/tags). 

## Authors

* **Alex Blackham** - *Developer and Maintainer* - [B3none](https://github.com/b3none)

See also the list of [contributors](https://github.com/b3none/gdprconsent/contributors) who participated in this project.

## Share the love

If you appreciate the project then please take the time to star our repository.

![Star us](.github/README_ASSETS/star_us.png)

## License

This project is licensed under the MIT License - see the [project license](license.md) file for details