https://github.com/oxid-esales/usercentrics
Cookie Consent Management module via usercentrics
https://github.com/oxid-esales/usercentrics
Last synced: about 1 year ago
JSON representation
Cookie Consent Management module via usercentrics
- Host: GitHub
- URL: https://github.com/oxid-esales/usercentrics
- Owner: OXID-eSales
- License: other
- Created: 2020-11-10T14:55:25.000Z (over 5 years ago)
- Default Branch: b-7.1.x
- Last Pushed: 2024-03-15T13:01:14.000Z (over 2 years ago)
- Last Synced: 2024-03-15T13:30:47.306Z (over 2 years ago)
- Language: PHP
- Size: 750 KB
- Stars: 17
- Watchers: 21
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# OXID Cookie Management powered by usercentrics
[](https://packagist.org/packages/oxid-professional-services/usercentrics)
This module provides the [Usercentrics](https://usercentrics.com/de/preise/?partnerid=16967#business-paket) functionality for the [OXID eShop](https://www.oxid-esales.com/) allowing you to use their Consent Management Platform.
## Usage
This assumes you have OXID eShop (at least the `v6.2.0` compilation) up and running.
### Install
The Usercentrics module is already included in the OXID eShop compilation.
Module can be installed manually, by using composer:
```bash
$ composer require oxid-professional-services/usercentrics
```
After requiring the module, you need to activate it, either via OXID eShop admin or CLI.
Navigate to oxideshop folder and execute the following:
```bash
$ vendor/bin/oe-console oe:module:activate oxps_usercentrics
```
### How to use
Activate the module and enter your usercentrics ID in the module settings.
User documentation: [DE](https://docs.oxid-esales.com/modules/usercentrics/de/latest/)
## Branch Compatibility
* b-7.1.x branch for b-7.1.x shop compilation branches
* b-7.0.x branch for b-7.0.x shop compilation branches
* b-6.5.x branch for b-6.5.x shop compilation branches
* b-6.3.x branch for b-6.3.x and b-6.4.x shop compilation branches
* b-6.2.x branch for b-6.2.x shop compilation branches
## Developer installation
```bash
$ git clone --branch=b-7.1.x https://github.com/OXID-eSales/usercentrics.git source/modules/oxps/usercentrics
$ composer config repositories.oxid-professional-services/usercentrics path ./source/modules/oxps/usercentrics
$ composer require oxid-professional-services/usercentrics:*
$ vendor/bin/oe-console oe:module:activate oxps_usercentrics
```
## Testing
For instructions on running tests, please refer to current version github development workflow.
## Contributing
You like to contribute? 🙌 AWESOME 🙌\
Go and check the [contribution guidelines](CONTRIBUTING.md)
## Issues
To report issues with the module, please use the [OXID eShop bugtracking system](https://bugs.oxid-esales.com/) - module Usercentrics project.
## License
OXID Module and Component License, see [LICENSE file](LICENSE).