Requirements

• PHP
• Composer
• Docker
• Docker Compose
• Make (GNU Make)

PHP Matrix versions

• PrestaShop 1.7.x

• PrestaShop 8.x

• PrestaShop 9.x

PHP Versions older than 8.x

To install PHP versions older than 8.x, please refer to these specific repositories:

• macOS using Homebrew: https://github.com/shivammathur/homebrew-php
• Ubuntu: https://launchpad.net/~ondrej/+archive/ubuntu/php

Build

1. Clone repository to local environment
2. Copy .env.dist -> .env
3. Configure the .env file to your environment settings.
4. Copy MODULE_VERSION/.env.dist -> MODULE_VERSION/.env
5. Copy the docker-compose.local.yml.dist -> docker-compose.local.yml
6. Uncomment the services in the docker-compose.local.yml file to your needs.
7. Run Makefile command in terminal make build
8. Run Makefile command in terminal make run
9. Website is accessible at http://localhost:8991
10. http://localhost:8991/admin1 - admin panel

Use default PrestaShop credentials to login:

• [email protected]
• prestashop_demo

Lint

Run make lint in terminal.

Run make phpcompat-71 to check PHP 7.1 compatibility for shared packages and ps17/ source files.

Tests

Unit tests

Run make unit-test in terminal.

Integration tests

Integration tests require a running Docker environment and a dedicated test database.

make up                  # Start containers (required)
make integration-test    # Creates test_prestashop DB, then runs tests

The make integration-test target automatically runs make create-test-db first, which drops and recreates a test_prestashop database from the current prestashop database. This ensures a consistent state before each run.

Note: If you only need to recreate the test database without running tests, use make create-test-db directly.

Contributing

PrestaShop modules are open source extensions to the PrestaShop e-commerce solution. Everyone is welcome and even encouraged to contribute with their own improvements.

Contributors wishing to edit a module's files should follow the following process:

1. Fork this project to your GitHub account.
2. Clone your fork to your local machine in the /modules directory of your PrestaShop installation.
3. Create a branch in your local clone of the module for your changes.
4. Change the files in your branch. Be sure to follow the coding standards
5. Push your changed branch to your fork in your GitHub account.
6. Create a pull request for your changes on the target branch of the module's project. Be sure to follow the contribution guidelines in your pull request. If you need help to make a pull request, read the GitHub help page about creating pull requests.
7. Wait for one of the maintainers either to review the code

License

This module is released under the Academic Free License 3.0