README

This module provides the Usercentrics functionality for the OXID eShop 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:

$ 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:

$ 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

Branch Compatibility

• b-7.4.x branch for b-7.4.x shop compilation branches
• b-7.3.x branch and v3.1.0 for b-7.3.x shop compilation branches
• b-7.2.x branch and v3.0.0 for b-7.2.x shop compilation branches
• b-7.1.x branch and v3.0.0 for b-7.1.x shop compilation branches
• b-7.0.x branch and v3.0.0 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

Development installation

We recommend developing the module as independent as possible. This means that the module for development should be installed as a root package, with its own strict dependencies if such are needed.

The next section shows how to install the module as a root package by using the OXID eShop SDK.

In case of different environment usage, please adjust by your own needs.

Development installation on OXID eShop SDK

The installation instructions below are shown for the current SDK for shop 7.4. Make sure your system meets the requirements of the SDK.

1. Ensure all docker containers are down to avoid port conflicts

2. Clone the SDK for the new project

echo MyProject && git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ && cd $_

1. Clone the repository to the source directory

git clone --recurse-submodules https://github.com/OXID-eSales/usercentrics.git --branch=b-7.4.x ./source

1. Run the recipe to setup the development environment, you can decide which shop edition to install. Omitting the flag installs EE.

./source/recipes/setup-development.sh

You should be able to access the shop with http://localhost.local and the admin panel with http://localhost.local/admin (credentials: noreply@oxid-esales.com / admin)

Testing

Linting, syntax check, static analysis

$ composer update
$ composer static

Unit/Integration/Acceptance tests

• Install this module in a running OXID eShop
• Reset the shop's database

$ bin/oe-console oe:database:reset --db-host=db-host --db-port=db-port --db-name=db-name --db-user=db-user --db-password=db-password --force

• Run all the tests

$ composer tests-all

• Or the desired suite

$ composer tests-unit
$ composer tests-integration
$ composer tests-codeception

Contributing

You like to contribute? 🙌 AWESOME 🙌
Go and check the contribution guidelines

Issues

To report issues with the module, please use the OXID eShop bugtracking system - module Usercentrics project.

License

OXID Module and Component License, see LICENSE file.