https://github.com/oxid-esales/media-library-module
Media Library Module
https://github.com/oxid-esales/media-library-module
Last synced: about 1 year ago
JSON representation
Media Library Module
- Host: GitHub
- URL: https://github.com/oxid-esales/media-library-module
- Owner: OXID-eSales
- License: other
- Created: 2023-08-07T07:47:15.000Z (almost 3 years ago)
- Default Branch: b-7.3.x
- Last Pushed: 2025-04-10T11:21:31.000Z (about 1 year ago)
- Last Synced: 2025-04-10T12:48:48.490Z (about 1 year ago)
- Language: PHP
- Size: 3.22 MB
- Stars: 16
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Media Library Module for OXID eShop
[](https://github.com/OXID-eSales/media-library-module/actions/workflows/trigger.yaml)
[](https://packagist.org/packages/oxid-esales/media-library-module)
[](https://github.com/oxid-esales/media-library-module)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_media-library-module)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_media-library-module)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_media-library-module)
Module provides basic media files management.
## Compatibility
### Versions
* v3.0.x is compatible with eShop compilation 7.3.x and higher
* 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](https://github.com/OXID-eSales/docker-eshop-sdk)
for shop 7.3. Make sure your system meets the requirements of the SDK.
0. Ensure all docker containers are down to avoid port conflicts
1. Clone the SDK for the new project
```shell
echo MyProject && git clone https://github.com/OXID-eSales/docker-eshop-sdk.git $_ && cd $_
```
2. Clone the repository to the source directory
```shell
git clone --recurse-submodules https://github.com/OXID-eSales/media-library-module.git --branch=b-7.3.x ./source
```
3. Run the recipe to setup the development environment
```shell
./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:
```shell
make php
composer tests-coverage
```
Commands can be also triggered directly on the container with docker compose, example:
```shell
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
```shell
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:
```shell
npm run watch
```
## License
OXID Module and Component License, see [LICENSE file](LICENSE).
## 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.