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: 2 months 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 (about 8 years ago)
- Default Branch: b-7.3.x
- Last Pushed: 2025-03-24T15:15:29.000Z (3 months ago)
- Last Synced: 2025-03-24T16:27:03.859Z (3 months ago)
- Topics: oxid-eshop, oxid-module, php, wysiwyg-editor
- Language: PHP
- Homepage:
- Size: 4.97 MB
- Stars: 19
- Watchers: 15
- Forks: 15
- 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
[](https://github.com/OXID-eSales/ddoe-wysiwyg-editor-module/actions/workflows/trigger.yaml)
[](https://packagist.org/packages/ddoe/wysiwyg-editor-module)
[](https://github.com/OXID-eSales/ddoe-wysiwyg-editor-module)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_ddoe-wysiwyg-editor-module)
[](https://sonarcloud.io/dashboard?id=OXID-eSales_ddoe-wysiwyg-editor-module)
[](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.3.x` is compatible with OXID eShop b-7.3.x branch, works with **Twig engine** only
* `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.3.x
* `composer require ddoe/wysiwyg-editor-module:dev-b-7.3.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 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/ddoe-wysiwyg-editor-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: [email protected] / 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
```
Navigate to the module directory and run:
```shell
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
```
## 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.