ppl / module-dev-quick-setup
Scenario planning and resumable run shell for Magento development demo setup.
PPL Dev Quick Setup for Magento 2
PPL Dev Quick Setup coordinates store, tax, article, customer, order, reindexing, cache, and readiness steps into resumable demo-shop scenarios.
What It Adds
- Scenario planning shell for a minimal working shop and a full merchant demo shop
- Resumable orchestration across existing PPL generator modules
- Readiness checks after setup steps complete
Requirements And Dependencies
- PHP: >=8.1
- Magento packages: magento/framework, magento/module-backend, magento/module-indexer
- PPL packages: ppl/module-dev-create-articles, ppl/module-dev-create-customers, ppl/module-dev-create-orders, ppl/module-dev-create-store, ppl/module-dev-create-taxes, ppl/module-dev-tool
Installation
Composer installation:
composer require ppl/module-dev-quick-setup
bin/magento module:enable Ppl_Hub Ppl_DevTool Ppl_DevCreateStore Ppl_DevCreateTaxes Ppl_DevCreateArticles Ppl_DevCreateCustomers Ppl_DevCreateOrders Ppl_DevQuickSetup
bin/magento setup:upgrade
bin/magento setup:di:compile
bin/magento cache:clean
Manual app/code installation: copy the module to app/code/Ppl/DevQuickSetup, install the dependencies listed above, then run the same Magento commands without the Composer step.
First Use
- Install Dev Tool plus Create Store, Taxes, Articles, Customers, and Orders first.
- Start with a small scenario before generating large demo datasets.
- Use the Full Merchant Demo Shop scenario when report modules need months of sales history.
Admin entry: PPL Hub > PPL Dev Tool > Quick Setup.
Integrations And Boundaries
- Combines Ppl_DevCreateStore, Ppl_DevCreateTaxes, Ppl_DevCreateArticles, Ppl_DevCreateCustomers, and Ppl_DevCreateOrders.
- Intended for development, QA, demo, or disposable staging environments. Do not treat generated data as production merchant data.
Localization
The package includes translation CSV files for 12 locales: de_DE, en_US, es_ES, fr_FR, it_IT, ja_JP, nl_NL, pl_PL, pt_BR, ru_RU, tr_TR, zh_CN.
Documentation
- Screenshot inventory:
docs/images/ppl-dev-quick-setup/in the repository documentation tree
Support
Support contact: [email protected]. Include the module version, Magento version, enabled PPL companion modules, and the relevant admin or storefront screenshot when reporting an issue.
Changelog
1.2.0
- Adapted to the updated PPL Hub: admin navigation, ACL, and menu integration aligned to the PPL Hub 1.2 line
- Minor fixes and stability improvements
1.0.0
- Initial release.
- Orchestrate the PPL Dev generator modules to stand up a complete demo or QA shop in one run.
Requires 29
| Package | Constraint |
|---|---|
| magento/framework | >=103.0.0 <104.0.0 |
| magento/module-backend | >=102.0.0 <103.0.0 |
| magento/module-catalog | >=104.0.0 <105.0.0 |
| magento/module-catalog-inventory | >=100.4.0 <101.0.0 |
| magento/module-config | >=101.2.0 <102.0.0 |
| magento/module-configurable-product | >=100.4.0 <101.0.0 |
| magento/module-customer | >=103.0.0 <104.0.0 |
| magento/module-eav | >=102.1.0 <103.0.0 |
| magento/module-indexer | >=100.4.0 <101.0.0 |
| magento/module-inventory | >=1.2.0 <2.0.0 |
| magento/module-newsletter | >=100.4.0 <101.0.0 |
| magento/module-persistent | >=100.4.0 <101.0.0 |
| magento/module-quote | >=101.2.0 <102.0.0 |
| magento/module-review | >=100.4.0 <101.0.0 |
| magento/module-sales | >=103.0.0 <104.0.0 |
| magento/module-store | >=101.1.0 <102.0.0 |
| magento/module-tax | >=100.4.0 <101.0.0 |
| magento/module-url-rewrite | >=102.0.0 <103.0.0 |
| magento/module-wishlist | >=101.2.0 <102.0.0 |
| php | >=8.1 |
| ppl/module-dev-create-articles | ^1.2 |
| ppl/module-dev-create-customers | ^1.2 |
| ppl/module-dev-create-orders | ^1.2 |
| ppl/module-dev-create-store | ^1.2 |
| ppl/module-dev-create-taxes | ^1.2 |
| ppl/module-dev-tool | ^1.2 |
| ppl/module-hub | ^1.2 |
| psr/log | ^1.0 || ^2.0 || ^3.0 |
| symfony/console | ^6.4 || ^7.0 |
Compatibility
Each Magento release line is installed on its supported PHP versions, then the module is built (DI compilation + static-content deploy) and its unit and integration suites are run. The matrix shows the lines and PHP versions the module is confirmed to install and run on. Code-quality results further down (phpstan, phpcs, …) are reported separately and never affect compatibility.
Code Quality
Advisory checks against the module's source. Static analysis runs once across the whole module; PHPStan re-runs per Magento + PHP version because resolvable symbols differ between releases. These NEVER affect the Compatibility badge. A phpcs finding can't make a module incompatible.
Static analysis
Coding standards (phpcs), mess detection (phpmd), copy-pasted code (cpd), PHP cross-version compatibility, composer.json validity. Each runs once for the whole module.
| Tool | Status | Findings | Summary |
|---|---|---|---|
| PHPCS | Pass | 0 | |
| PHPMD | Warning | 26 | 26 rule violations (MissingImport:12, UnusedFormalParameter:5, CyclomaticComplexity:4, NPathComplexity:3, TooManyMethods:1) |
| Cpd | Warning | 1 | 1 duplicated chunk spanning 30 total lines (min-lines=5, min-tokens=70) |
| Composer validate | Info | 1 | valid; 1 advisory note (composer validate --strict) |
PHPStan
Type-checks the module's PHP against a real Magento install at the configured gate level. Re-runs per Magento and PHP version because resolvable symbols differ between releases.
Tests
Unit and integration suites, run for each applicable Magento and PHP version. A test failure speaks to the module's behaviour, not its compatibility with a Magento line, so it is reported here separately and never reddens the compatibility matrix.
Unit tests
Integration tests
| Magento | PHP 8.2 | PHP 8.3 | PHP 8.4 | PHP 8.5 |
|---|---|---|---|---|
| 2.4.7 | N/A | N/A | ||
| 2.4.8 | N/A | N/A | ||
| 2.4.9 | N/A | N/A |
Security
Security checks run directly against the module: an audit of its declared dependencies for known vulnerabilities (composer audit) and a scan of its source for malware and web-shell signatures. Each runs once. A malware detection fails the version outright.
More from Pawel Pliousnin Digital Solutions
View vendorPPL Dev Tool add-on for creating repeatable Magento 2 development tax classes, rates and rules.
Magento 2 admin development hub for search simulation, generated-data cleanup and optional seed-data add-ons.
PPL Dev Tool add-on for creating repeatable Magento 2 development store setup data and configuration.
PPL Dev Tool add-on for generating repeatable Magento 2 seed orders for reports, QA and demos.
Turn an existing module into recurring revenue.
If you already maintain a Magento 2 module on GitHub or GitLab, listing it on Packagento takes about five minutes. We mirror your tags, handle distribution signing, and route paid licenses through Stripe Connect, so you can keep shipping the way you already do.