Skip to content

Latest commit

 

History

History
95 lines (52 loc) · 4.06 KB

CONTRIBUTING.md

File metadata and controls

95 lines (52 loc) · 4.06 KB
Raw

First off, thanks for taking the time to contribute!

Table of contents

Getting started

The development environment requires Docker and Docker Compose to run. Please refer to the official documentation for step-by-step installation guide.

Clone the repository:

$ git clone [email protected]:sendsmaily/smaily-prestashop-module.git

Next, change your working directory to the local repository:

$ cd smaily-prestashop-module

Install composer dependencies:

$ composer install --working-dir src/

And run the environment:

$ docker compose up -d

You can access PrestaShop store from http://localhost:8080 and administration interface from http://localhost:8080/admin-dev URL.

Administrator user is [email protected] and password prestashop.

Internals

Structure of the repository

The repository is split into multiple parts:

  • .github - GitHub issue and pull request templates, and release workflow;
  • assets - images for the user guide;
  • src - module files;

Source files must follow standard PrestaShop module structure. Learn more about it from the Modules Folder structure chapter in the official documentation.

Development

All written code must follow PrestaShop's coding standards and naming conventions.

Starting the environment

You can run the environment by executing:

$ docker compose up -d

Note! Make sure you do not have any other process(es) listening on ports 8080 and 8888.

Developing in VS Code Remote Container

It is advised to develop the application inside VS Code remote container. This allows to get PHP IntelliSense on PrestaShop classes, includes, etc and provides an debugging option when using latest version of the prestashop/prestashop-flashlight image. Open /var/www/html directory of prestashop container as this provides context for IntelliSense.

Stopping the environment

Environment can be stopped by executing:

$ docker compose down --remove-orphans

Resetting the environment

If you need to reset the installation, just simply delete environment's Docker volumes. Easiest way to achieve this is by running:

$ docker compose down --remove-orphans -v

Troubleshooting

PHP CS Fixer is not working

You may notice that php-cs-fixer might not work for some PrestaShop image versions. php-cs-fixer output provides a hint that the /var/www/html/tests directory does not exist. This is due to the tests folder being included in the PrestaShop repo but not in the docker image. Adding an empty /var/www/heml/tests folder enables the php-cs-fixer.

Invalidating cache

There seems to be lot of issues related to cache being invalid. Sometimes the module routes are not found or services configuration is missing etc. Most of them can be fixed by pruning cache folder located in /var/www/html/var/cache/dev. Some versions use admin-dev folder.

Translating the module and Extracting translations

PrestaShop allows to extract and translate the module in the admin panel.

First you need to import the localization pack for the translatable language. Navigate to International > Localization and import the localization pack you want the module to be translated to.

To translate the module navigate to International > Translations. Under Modify translations section select Installed modules translations as the type, Smaily for PrestaShop.

Export the module translations and add them to translations directory.