README

Module provides basic media files management.

Compatibility

Versions

v2.1.x is compatible with eShop compilation 7.2.x and higher
v2.0.x is compatible with eShop compilation 7.1.x and higher
v1.0.x is compatible with eShop compilation 7.1.x and higher

Branches

b-7.3.x is compatible with shop b-7.3.x branches
b-7.2.x is compatible with shop b-7.2.x branches
b-7.1.x is compatible with shop b-7.1.x branches

Development installation on OXID eShop SDK

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

Ensure all docker containers are down to avoid port conflicts
Clone the SDK for the new project

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

Clone the repository to the source directory

git clone --recurse-submodules https://github.com/OXID-eSales/media-library-module.git --branch=b-7.3.x ./source

Run the recipe to setup the development environment

./source/recipes/setup-development.sh

You should be able to access the shop via

Frontend http://localhost.local
Admin Panel: http://localhost.local/admin
- (credentials: noreply@oxid-esales.com / admin)

Running the tests and quality tools

Check the "scripts" section in the composer.json file for the available commands. Those commands can be executed by connecting to the php container and running the command from there, example:

make php
composer tests-coverage

Commands can be also triggered directly on the container with docker compose, example:

docker compose exec -T php composer tests-coverage

Rebuilding the assets

To rebuild the assets, latest node docker container can be used. The one is pulled automatically if you are using the installation method from the previous section. What is left - connect to the container, install the npm dependencies and run the assets building process

make node
npm install
npm run build

Alternatively, if you're actively developing and want changes to be applied automatically, you can enable watch mode:

npm run watch

License

OXID Module and Component License, see LICENSE file.

Bugs and Issues

If you experience any bugs or issues, please report them in the section module Media Library of https://bugs.oxid-esales.com.

oxid-esales / media-library-module

Maintainers

Details