README

About

ps_onepagecheckout is the native PrestaShop module that provides the one-page checkout experience.

Warning

This module is under heavy development. It is not production-ready and should not be used in live environments.

Compatibility

PrestaShop: 9.2.0 or later.

What the module owns

checkout process injection through actionCheckoutBuildProcess,
front office AJAX endpoints for guest initialization and address form refresh,
back office configuration for enabling or disabling one-page checkout,
checkout layout configuration assets and templates shipped by the module,
checkout runtime flag exposure for the order page.

Code map

ps_onepagecheckout.php: module entry point, hook registration, runtime wiring.
src/Checkout: checkout process, availability checks, AJAX handlers.
src/Form: back office configuration form and checkout form helpers.
controllers/front: FO endpoints used by the one-page checkout runtime.
controllers/admin: BO entry point for module configuration.
views/js: checkout client-side behavior.
views/templates: BO templates and module-owned checkout assets.
tests/php: unit and integration coverage for the module.

Contributing

Before opening a PR:

Regenerate the module autoload when PHP classes move or are added.
Rebuild front assets when changing files under views/js, and commit the generated bundles from views/public (including .LICENSE.txt files).
Run the relevant PHP tests for the area you touched.
Use the decision log and implementation rules as the source of truth for sensitive changes.

Local development

PHP dependencies and autoload

From the repository root, install Composer dependencies (required for the module autoload):

composer install -d
composer dump-autoload -d

Front assets

From ps_onepagecheckout/views:

npm install

# Development: rebuild assets on every change under views/js
npm run watch

# Production build: generate bundles consumed by the module
npm run build

When you change any file under views/js:

run npm run build to regenerate:
- views/public/opc-guest-init.bundle.js
- views/public/opc-address.bundle.js
- their corresponding *.LICENSE.txt files,
and commit both the source changes and the updated files in views/public.

The CI workflow js.yml runs npm run build to ensure the assets remain buildable, and the shared build-release workflow packages the module using the files present in the repository (including the generated bundles).

Testing

PHP test configuration lives in tests/php:

unit suite: modules/ps_onepagecheckout/tests/php/phpunit.xml
integration suite: modules/ps_onepagecheckout/tests/php/phpunit-integration.xml
static analysis helpers: modules/ps_onepagecheckout/tests/php/phpstan.sh

Run PHPUnit in the same isolated Docker environment locally and in GitHub Actions:

./scripts/run-tests.sh unit
./scripts/run-tests.sh integration

The runner expects a prepared PrestaShop checkout in ../prestashop by default. Override it with PS_ROOT_DIR_HOST=/path/to/prestashop when needed. Integration tests provision MySQL automatically inside Docker.

For end-to-end checks, use the dedicated runbook:

docs/E2E_RUNBOOK.md

Project references

implementation rules: docs/RULES.md
architectural decisions: docs/DECISIONS.md
translations (i18n): docs/TRANSLATIONS.md
contributors: CONTRIBUTORS.md

License

This module is released under the Academic Free License 3.0.

prestashop / ps_onepagecheckout

Maintainers

Package info

Statistics

Security