diff --git a/README.md b/README.md index 9f7875285f6b0740cd7fea5eb0ca33291f71a4bc..5e87fd814b6e4112483d5e22dab82fd46e92b980 100644 --- a/README.md +++ b/README.md @@ -1,94 +1,129 @@ -# magento-uafrica-shipping-extension - -## Local dev setup: - -1. Create a new folder on your local machine -2. Copy the following docker-compose file into it (remember to unzip):[docker-compose.yml.zip](https://github.com/uafrica/magento-uafrica-shipping-extension/files/10193253/docker-compose.yml.zip) -3. Run `docker compose up` - +# Magento 2 uAfrica Shipping Extension ## Introduction -A guide to install Magento uAfrica Shipping extension +A complete guide to install Magento uAfrica Shipping extension in Magento 2. ## Features -This extension allows you to get real-time shipping rates from Bobgo shipping service and display them to your customers during checkout. - +>This extension allows you to get real-time shipping rates from BobGo shipping services and display them to your customers during checkout. -This extension also allows you to track shipments. +>This extension also allows you to track shipments and get delivery status updates from BobGo shipping services. ## How to install Magento 2 Bobgo Shipping Extension -### ✓ Install via composer (recommend) +### Option 1 (recommended): Install via composer Run the following command in Magento 2 root folder:</br> -<_Note: You must have composer installed on your server & at this point this option does not work, -, option working is manual, although everything is set and ready for installation through composer from https://packagist.org/_ > +>_Note: You must have composer installed on your server & at this point this option_ + +#### 1. Execute the following command to install the module: ``` composer require uafrica/bobgo +``` +#### 2. Enter following commands to enable the module: + +``` +php bin/magento module:enable uafrica_Customshipping +php bin/magento cache:clean +php bin/magento cache:flush php bin/magento setup:upgrade +php bin/magento setup:di:compile php bin/magento setup:static-content:deploy ``` -### ✓ Install via zip file - -1. Download the extension -2. Unzip the file +### Option 2: Install via zip file -3. Create a folder {Magento root}/app/code/uafrica/Customshipping +1. Download the extension zip file from the link below: </br> -4. Copy the content from the unzip folder(Registration.php, etc, view, etc) to {Magento root}/app/code/uafrica/Customshipping) +<a href="https://github.com/uafrica/magento-uafrica-shipping-extension/archive/refs/heads/main.zip"> Download Magento 2 uAfrica Shipping Extension </a> +2. Unzip the file and copy contents +>**{Magento root}**`/app/code/`**{Paste here}** -5. Go to Magento root folder and run upgrade `bin/magento setup:upgrade` command line to install `uafrica_Customshipping`: +**It should look like this:** </br> +>{Magento root}/app/code/uafrica/Customshipping/ +3. Go to Magento root folder and run upgrade `bin/magento setup:upgrade` command line to install `uafrica_Customshipping`: </br> ``` Bin/magento cache:clean Bin/magento cache:flush Bin/magento setup:upgrade Bin/magento setup:di:compile ``` +_____________________________________________________________________________________________________________________ +### After installation -## How to configure Magento 2 Bobgo Shipping Extension +## How to configure Magento 2 uAfrica Shipping Extension ### ✓ Step 1: Create an account on Bobgo -You need to create an account on Bobgo to get API key and API secret<Not Sure About This At This Point> . Please visit [Bobgo](https://bobgo.co.za) to create an account. +You need to create an account on Bobgo to get your Store Identified by the API. + +Please visit [Bobgo](https://uafrica.co.za) to create an account. ### ✓ Step 2: Login to Magento Admin -Login to Magento Admin and go to `Stores > Configuration > Sales > Delivery Methods` +1. Click on UAFRICA > bobGo > Enabled for Checkout > Yes </br> + + +2. and go to `Stores > Configuration > Sales > Delivery Methods` to configure the extension. + +[//]: # (### ✓ Step 3: Configure Bobgo Shipping Extension) + +[//]: # () +[//]: # (1. Select `Bobgo` as shipping method) + +[//]: # (2. Enter API key and API secret) + +[//]: # (3. Select `Enable` to enable the extension) + +[//]: # (4. Select `Enable Debug Mode` to enable debug mode) + +[//]: # (5. Click `Save Config`) + +[//]: # (6. Flush cache (System > Cache Management) and reindex (System > Index Management)) + +[//]: # (7. Clear generated files(`rm -rf var/generation/*`)) + +[//]: # (8. Reindex data (`php bin/magento indexer:reindex`)) + +[//]: # (9. Deploy static content (`php bin/magento setup:static-content:deploy`)) + +[//]: # (10. Run `php bin/magento cache:clean`) + +[//]: # (11. Run `php bin/magento cache:flush`) + +[//]: # (12. Run `php bin/magento setup:upgrade`) + +[//]: # (13. Run `php bin/magento setup:di:compile`) + +[//]: # (14. Run `php bin/magento setup:static-content:deploy`) + +## How it works -### ✓ Step 3: Configure Bobgo Shipping Extension +## How to use Magento 2 Bobgo Shipping Extension (carrier) to Ship Orders -1. Select `Bobgo` as shipping method -2. Enter API key and API secret -3. Select `Enable` to enable the extension -4. Select `Enable Debug Mode` to enable debug mode -5. Click `Save Config` -6. Flush cache (System > Cache Management) and reindex (System > Index Management) -7. Clear generated files(`rm -rf var/generation/*`) -8. Reindex data (`php bin/magento indexer:reindex`) -9. Deploy static content (`php bin/magento setup:static-content:deploy`) -10. Run `php bin/magento cache:clean` -11. Run `php bin/magento cache:flush` -12. Run `php bin/magento setup:upgrade` -13. Run `php bin/magento setup:di:compile` -14. Run `php bin/magento setup:static-content:deploy` +### ✓ Step 1: Add products to cart(Checkout) -## How to use Magento 2 Bobgo Shipping Extension (carrier) to ship orders +>1. Add products to cart +>2. Go to checkout page +>3. Select shipping address +>4. BobGo will collect Shipping Rates that cart +>5. Select shipping method +>6. Place order -### ✓ Step 1: Create shipment +### ✓ Step 1: Create shipment (Admin) +`Sales > Orders > View Order > Ship` -1. Go to `Sales > Orders` in Magento Admin -2. Select an order -3. Click `Ship` button -4. Select `Bobgo` as shipping method -5. Click `Submit Shipment` button +>1. Go to `Sales > Orders` in Magento Admin +>2. Select an order +>3. Click `Ship` button +>4. Select `uAfrica` as shipping method +>5. Click `Submit Shipment` button