|
1 | | -# TIG Postcode validation Magento 2 |
| 1 | +<p align="center"><img src="https://postcodeservice.com/wp-content/uploads/2021/01/postcode-service-logo__Logo-color.svg" width="300px" /></p> |
2 | 2 |
|
3 | | -[](https://coveralls.io/github/tig-nl/postcode-magento2?branch=%28no+branch%29) [](https://travis-ci.org/tig-nl/postcode-magento2) |
| 3 | +# Postcode Service Magento 2 |
| 4 | +[](https://github.com/tig-nl/postcode-magento2/releases/latest) |
| 5 | + |
| 6 | + |
| 7 | +[](https://packagist.org/packages/tig-nl/postcode-magento2/stats) |
| 8 | + |
4 | 9 |
|
5 | | -Install the extension with composer |
| 10 | + |
| 11 | +## Requirements |
| 12 | +- Magento version 2.4.5, 2.4.4, 2.3.7 or 2.3.6 |
| 13 | +- PHP 7.3+ |
| 14 | + |
| 15 | +## Installation |
| 16 | +We strongly recommend that you use a Staging Environment for the installation, and to also make a backup of your environment. |
| 17 | + |
| 18 | +### Installation using composer (recommended) |
| 19 | +To install the extension login to your environment using SSH. Then navigate to the Magento 2 root directory and run the following commands in the same order as described: |
| 20 | + |
| 21 | +Enable maintenance mode: |
| 22 | +~~~~shell |
| 23 | +php bin/magento maintenance:enable |
6 | 24 | ~~~~ |
| 25 | + |
| 26 | +1. Install the extension: |
| 27 | +~~~~shell |
7 | 28 | composer require tig/postcode-magento2 |
8 | 29 | ~~~~ |
9 | 30 |
|
| 31 | +2. Enable the Postcode Service Magento 2 extension |
| 32 | +~~~~shell |
| 33 | +php bin/magento module:enable TIG_Postcode |
| 34 | +~~~~ |
| 35 | + |
| 36 | +3. Update the Magento 2 environment: |
| 37 | +~~~~shell |
| 38 | +php bin/magento setup:upgrade |
| 39 | +~~~~ |
| 40 | + |
| 41 | +When your Magento environment is running in production mode, you also need to run the following comands: |
| 42 | + |
| 43 | +4. Compile DI: |
| 44 | +~~~~shell |
| 45 | +php bin/magento setup:di:compile |
| 46 | +~~~~ |
| 47 | + |
| 48 | +5. Deploy static content: |
| 49 | +~~~~shell |
| 50 | +php bin/magento setup:static-content:deploy |
| 51 | +~~~~ |
| 52 | + |
| 53 | +6. Disable maintenance mode: |
| 54 | +~~~~shell |
| 55 | +php bin/magento maintenance:disable |
| 56 | +~~~~ |
| 57 | + |
| 58 | +### Installation manually |
| 59 | +1. Download the extension directly from [github](https://github.com/tig-nl/postcode-magento2) by clicking on *Code* and then *Download ZIP*. |
| 60 | +2. Create the directory *app/code/TIG/Postcode* (Case-sensitive) |
| 61 | +3. Extract the zip and upload the code into *app/code/TIG/Postcode* |
| 62 | +4. Enable the Postcode Service Magento 2 extension |
| 63 | +~~~~shell |
| 64 | +php bin/magento module:enable TIG_Postcode |
| 65 | +~~~~ |
| 66 | + |
| 67 | +5. Update the Magento 2 environment: |
| 68 | +~~~~shell |
| 69 | +php bin/magento setup:upgrade |
| 70 | +~~~~ |
| 71 | + |
| 72 | +## Update |
| 73 | +To update the Postcode Service Extension run the following commands: |
| 74 | +~~~~shell |
| 75 | +composer update tig/postcode-magento2 |
| 76 | +php bin/magento setup:upgrade |
| 77 | +~~~~ |
| 78 | + |
| 79 | +## Examples |
| 80 | + |
| 81 | +### Dutch Postcode Service within the Magento 2 checkout |
| 82 | + |
| 83 | + |
| 84 | +### Belgium Postcode Service within the Magento 2 checkout |
| 85 | + |
10 | 86 |
|
| 87 | +## Documentation |
11 | 88 | For further installation guidance |
12 | 89 | https://developers.postcodeservice.com/ |
0 commit comments