oxid-esales/developer-tools

The component contains developer tools.

Installs: 123 767

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 13

Forks: 0

Open Issues: 0

Type:oxideshop-component

v2.1.0 2022-10-28 13:15 UTC

README

This component contains additional developer tools for OXID eShop.

Installation

Run the following command to install the component:

composer require oxid-esales/developer-tools

Usage

Resetting project configuration

To reset project configuration to its initial state execute:

bin/oe-console oe:module:reset-configurations 

Resetting/installing shop database

To reset the database to its initial state run the following command:

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]

Which:

- <db-host> is the database host
- <db-port> is the database port
- <db-name> is the database name
- <db-user> is the database username
- <db-password> is the database password
- [<force>] (optional) if set runs the command without confirmation

Example:

bin/oe-console oe:database:reset --db-host=localhost --db-port=3306 --db-name=test --db-user=test --db-password=test 

ATTENTION: After running this command, all you data will be deleted from the database. Never run this command on life system.

How to install component for development?

Checkout component besides OXID eShop source directory:

git clone https://github.com/OXID-eSales/developer-tools.git

Run composer install command:

cd developer-tools
composer install

Add dependency to OXID eShop composer.json file:

composer config repositories.oxid-esales/developer-tools path developer-tools
composer require --dev oxid-esales/developer-tools:*

How to run tests?

To run tests for the component please define OXID eShop bootstrap file:

vendor/bin/phpunit --bootstrap=../source/bootstrap.php tests/

License

See LICENSE file for license details.