Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/oxid-esales/ddoe-wysiwyg-editor-module

Summernote WYSIWYG Editor for OXID eShop
https://github.com/oxid-esales/ddoe-wysiwyg-editor-module

oxid-eshop oxid-module php wysiwyg-editor

Last synced: 4 days ago
JSON representation

Summernote WYSIWYG Editor for OXID eShop

Host: GitHub
URL: https://github.com/oxid-esales/ddoe-wysiwyg-editor-module
Owner: OXID-eSales
License: other
Created: 2017-04-20T12:07:59.000Z (over 7 years ago)
Default Branch: b-7.2.x
Last Pushed: 2024-12-23T20:29:55.000Z (16 days ago)
Last Synced: 2024-12-28T23:48:07.692Z (11 days ago)
Topics: oxid-eshop, oxid-module, php, wysiwyg-editor
Language: PHP
Homepage:
Size: 4.21 MB
Stars: 19
Watchers: 17
Forks: 14
Open Issues: 1
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

# Summernote WYSIWYG Editor for OXID eShop

[![Development](https://github.com/OXID-eSales/ddoe-wysiwyg-editor-module/actions/workflows/trigger.yml/badge.svg?branch=b-7.2.x)](https://github.com/OXID-eSales/ddoe-wysiwyg-editor-module/actions/workflows/trigger.yml)
[![Latest Version](https://img.shields.io/packagist/v/ddoe/wysiwyg-editor-module?logo=composer&label=latest&include_prereleases&color=orange)](https://packagist.org/packages/ddoe/wysiwyg-editor-module)
[![PHP Version](https://img.shields.io/packagist/php-v/ddoe/wysiwyg-editor-module)](https://github.com/OXID-eSales/ddoe-wysiwyg-editor-module)

[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_ddoe-wysiwyg-editor-module&metric=alert_status)](https://sonarcloud.io/dashboard?id=OXID-eSales_ddoe-wysiwyg-editor-module)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_ddoe-wysiwyg-editor-module&metric=coverage)](https://sonarcloud.io/dashboard?id=OXID-eSales_ddoe-wysiwyg-editor-module)
[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=OXID-eSales_ddoe-wysiwyg-editor-module&metric=sqale_index)](https://sonarcloud.io/dashboard?id=OXID-eSales_ddoe-wysiwyg-editor-module)

# Compatibility

### Versions
* versions `4.2.x` - compatible with OXID eShop compilation 7.2.x and higher
* versions `4.x` - compatible with OXID eShop compilation 7.1.x
* versions `3.x` - compatible with OXID eShop compilation 7.0.x
* versions `2.x` - compatible with OXID eShop compilation 6.0.x - 6.5.x

### Branches
* `b-7.2.x` is compatible with OXID eShop b-7.2.x branch, works with **Twig engine** only
* `b-7.1.x` is compatible with OXID eShop b-7.1.x branch, works with **Twig engine** only
* `b-7.0.x` is compatible with OXID eShop b-7.0.x branch and supports **Legacy Smarty engine**
* `b-2.x` is compatible with OXID eShop compilations: 6.2.x - 6.5.x

### Module installation via composer

In order to install the module via composer run one of the following commands in commandline in your shop base directory
(where the shop's composer.json file resides).
* `composer require ddoe/wysiwyg-editor-module:^4.2.0`
to install the latest released version compatible with OXID eShop v7.2.x
* `composer require ddoe/wysiwyg-editor-module:dev-b-7.2.x`
to install the specific unreleased branch

### Module activation in OXID eShop Admin
After installation, please, activate the module in OXID eShop Admin
`EXTENSIONS -> Modules -> "Summernote WYSIWYG Editor for OXID eShop" -> Activate`

# Development installation

The installation paths in commands below are fitting current [SDK](https://github.com/OXID-eSales/docker-eshop-sdk).
In case of different environment usage, please adjust by your own needs.

```shell
# Clone the repository
cd
git clone https://github.com/OXID-eSales/ddoe-wysiwyg-editor-module.git --branch=b-7.2.x source/dev-packages/wysiwyg

docker compose exec -T \
php composer config repositories.ddoe/wysiwyg-editor-module \
--json '{"type":"path", "url":"./dev-packages/wysiwyg", "options": {"symlink": true}}'
docker compose exec -T php composer require ddoe/wysiwyg-editor-module:* --no-update

# Activate modules
bin/oe-console oe:module:activate ddoemedialibrary
bin/oe-console oe:module:activate ddoewysiwyg
```

## Bugs and Issues

If you experience any bugs or issues, please report them in the section **WYSIWYG Editor + Media Gallery** of https://bugs.oxid-esales.com.