diff --git a/Installation guide - Bob Go shipping extension for Magento 2.pdf b/Installation guide - Bob Go shipping extension for Magento 2.pdf new file mode 100644 index 0000000000000000000000000000000000000000..2b410bed7e7f035526b31166ae6838292cd7d39b Binary files /dev/null and b/Installation guide - Bob Go shipping extension for Magento 2.pdf differ diff --git a/Readme.md b/Readme.md index fcb6fb88a897b0fe65141ac458fc1de46b5f6343..e85f78fa7cbd9a3da16ba3f9a342e2ef2726e4d9 100644 --- a/Readme.md +++ b/Readme.md @@ -1,97 +1,3 @@ -# Magento 2 Bob Go Shipping Extension +# Bob Go shipping extension for Magento 2 -## Introduction - -A complete guide to install Magento Bob Go Shipping extension in Magento 2. - -## Features ->This extension allows you to get real-time shipping rates from Bob Go shipping services and display them to your customers during checkout. - ->This extension also allows you to track shipments and get delivery status updates from Bob Go shipping services. - -## How to install Magento 2 Bob Go Shipping Extension - -### 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 for this option_ - -#### 1. Execute the following command to install the module: - -``` -composer require bobgo/bobgo-magento-extension -``` -#### 2. Enter following commands to enable the module: - -``` -bin/magento module:enable BobGroup_BobGo -bin/magento cache:clean -bin/magento cache:flush -bin/magento setup:upgrade -bin/magento setup:di:compile -bin/magento setup:static-content:deploy -``` - -### Option 2: Install via zip file - -1. Download the extension zip file from the link below: </br> - - <a href="https://gitlab.bob.co.za/bob-public-utils/bobgo-magento-extension/-/archive/prod/bobgo-magento-extension-prod.zip"> Download Magento 2 Bob Go Shipping Extension </a> - -2. Unzip the file and copy contents - -3. Create `BobGroup/BobGo` <em>Directory</em> - -**It should look like this:** </br> ->{Magento root}/app/code/BobGroup/BobGo/ - - ->**{Magento root}**`/app/code/BobGroup/BobGo/`**{Paste here}** - - -4. Go to Magento root folder and run all commands below to install `BobGroup_BobGo`: </br> -``` -bin/magento cache:clean -bin/magento cache:flush -bin/magento setup:upgrade -bin/magento setup:di:compile -bin/magento setup:static-content:deploy -``` -_____________________________________________________________________________________________________________________ -# After installation - - -## How to configure Magento 2 Bob Go Shipping Extension - -### ✓ Step 1: Create an account on Bob Go - -You need to create an account on Bob Go to get your store identified by the API. - -Please visit [Bob Go](https://bobgo.co.za) to create an account. - -### ✓ Step 2: Integrate Magento and Bob Go - -1. In the Magento admin portal click on `System > Integrations` and click on `Add New Integration` -2. Under `Basic Settings > Integration Info` fill in the name of the integration eg. Bob Go -3. Under `Basic Settings > API` select `All` for Resource access -4. Click `Save` and enter your Magento admin portal password -5. The `Integration Details` will be displayed on the page -6. On [Bob Go](https://bobgo.co.za) go to `Sales channels > Add channel > Magento` and enter the Magento integration details from step 5 and click `Grant access` -7. On Bob Go go to `Rates at checkout > Settings > Installed channels` and enable your channel for rates at checkout -8. Make sure you have service levels configured and enabled on Bob Go `Rates at checkout > Service levels` - -### ✓ Step 3: Login to Magento Admin - -1. In the Magento admin portal click on `Stores > Configuration > Sales > Delivery Methods` -2. Go to the Bob Go delivery method and enable Bob Go rates at checkout -3. Click `Save Config` -4. A message at the top of the screen will confirm that rates at checkout is enabled correctly: `Bob Go rates at checkout connected.` - -#### Admin Configurations: Update Store Information* - -When the extension is **installed** and **enabled**, a new field will be created in `Store Information` : `Suburb`. Enter the necessary details: - -1. `Stores`> `Configuration`> `General`>`General` -2. `Store Information`>`Suburb` -3. Update the store information and click `Save config` +See the installation guide for information: [Installation Guide](./Installation guide - Bob Go shipping extension for Magento 2.pdf) \ No newline at end of file