README

Shogun Page Builder module for Magento 2

Description

This module connects a magento server and its websites to Shogun, allowing magento administrators (admin users) the ability to create and design pages in Shogun and publish them to your magento websites.

To accomplish this, this module adds:

An entry to integrations called 'Shogun Page Builder - Integration', which can be seen in the administrator backend under the section Extensions -> Integrations

This integration allows Shogun to use a magento installation's Admin Rest API, which is how Shogun will authenticate with the magento server, publish pages, and much more.

New custom API endpoints that allows Shogun to access or submit other information not given by the default magento admin rest API that Shogun needs to function correctly

For example, to allow for a page to be published to a certain store view (versus all store views) the Block & Page magento models needed to be modified to allow for submitting a store_id

A new admin section (located under Content -> Shogun Labs -> Shogun Page Builder) which embeds Shogun via an Iframe into the page, and allows admin users the ability to create, edit, and delete new magento pages with ease.

Requirements

Magento 2.0+
A paid subscription to Shogun
- After activating the integration in the magento admin, your site and user accounts will be created automatically on Shogun, and you'll be prompted to choose a plan after accessing the page builder for the first time.
A reachable & secure (HTTPS) url for your magento server
- This module connects to your Magento Admin REST API, and so will need a callback url it can reach. Local machines (localhost/0.0.0.0/local.dev) will need to use a tool like Ngrok to proxy requests to their development machine if they wish to complete the oauth process.
A valid admin email address
- Shogun verifies logins with a magic link that is sent from Shogun to the admin user's email account. Make sure the admin account you'll be using shogun with can be emailed from an outside mailing source.

Preinstallation Notes

Before you install, you might want to set your server to maintenance mode, and backup your database. After you install, you'll want to disable maintenance mode, redeploy any static content, and clean the cache.

Enable maintenance mode: bin/magento maintenance:enable
Redeploy assets: bin/magento setup:static-content:deploy
Clean the cache: bin/magento cache:clean
Disable maintenance mode: bin/magento maintenance:disable

Installation

Via Magento Marketplace

Visit our extension page on the Magento Marketplace

Make sure you are logged into your magento account.

Click the Add To Cart button
Go to the checkout page and click Place Order
Click the Install button

At this point, go back to your Magento administrator backend, and do the following steps:

Go to System -> Web Setup Wizard
Click on the Extension Manager button
Click on the Review and Install button
Search for shogun_labs/module-shogun-page-builder on the listings, and click Install (you may need to paginate through multiple pages to find it, depending on how many extensions are listed)
Click on the Start Readiness Check button, then click the Next button at the top right once complete
Create a backup if needed, or uncheck all backups and then click the Next button at the top right
Wait for the 'Component Install' stage to finish

Via Composer

Navigate to your magento installation's root folder, and run the following commands below to install Shogun Page Builder via composer:

composer require shogun_labs/module-shogun-page-builder ">=1.0.7"
bin/magento setup:upgrade
bin/magento setup:di:compile

Manual Installation

Download/clone this module from Github (https://github.com/getshogun/module-shogun-page-builder)
- From the command line: git clone git@github.com:getshogun/module-shogun-page-builder.git
Place the downloaded module folder into the app/code folder in your magento base directory
- The directory path should look something like /var/www/html/app/code/shogun_labs/module-shogun-page-builder/...)
Run the following commands from your magento installation root folder:
- bin/magento setup:upgrade
- bin/magento setup:di:compile

Setup (after completing installation)

Verify and activate integration

Login to your magento backend admin and go to System -> Integrations
You should see an entry in the list of integrations for Shogun Page Builder - Integration - click Activate
When the confirmation dialog appears, click Allow.
A new popup window will appear when integrating with Shogun. Once it disappears, you should be taken back to the main integrations page, at which point the integration's status should be 'Active'.

Access the Shogun Page Builder via the admin backend

Navigate in the admin to Content -> Shogun Labs -> Shogun Page Builder
Select a Store View to use Shogun with. If you have only one store, this should be the Default Store View.
An iframe loading Shogun should appear.
- If you have already signed in, you'll be taken straight to the Shogun dashboard.
- If you have not signed in before to Shogun, a message asking to confirm your login will appear, which will send you an email confirming your login.
  - Once you've gotten the email and clicked the confirmation, you'll be logged into Shogun for that store view.

Frequently Asked Questions (FAQ)

Note: If your questions aren't answered below, or you have a special request, please reach out to us at magento@getshogun.com and we'll help you out.

Shogun Account

Do I need to sign up for a Shogun account beforehand? No, during the initial intigration activation process from your magento admin, we will create accounts on Shogun for you automatically.
Is there a free trial for Shogun? Yes, all plans/subscriptions on Shogun come with a free trial before being charged.
Can I use the Shogun module without a Shogun account or plan/subscription? No, the page builder requires a Shogun account to work correctly, and you must choose a plan/subscription after first logging into the tool, but as mentioned previously, all plans come with a free trial period.
How are plans/subscriptions charged via Shogun? Shogun is a Software as a Service that is charged to a credit card on a monthly basis.

After you complete installation, and navigate to the Shogun Page Builder in your magento admin, you'll be asked to choose a store view (if multi-store/multi-website), and then once logged in to Shogun, you'll be asked to choose a plan and enter your credit card details.

If you wish to use multiple stores with Shogun, each store you switch to will require you to repeat the above process, and will require a separate plan for Shogun.

Setup

I can't complete the activate integration step. What do I do? First, make sure that your Magento server can be accessed from a remote location via HTTPS, as Magento integrations require this in order for the integration setup to complete.

If you are working on local developer instance of Magento, for example, you may not be able to do this without using a tool like Ngrok to proxy requests to your development machine.

License

Open Software License ("OSL") v3.0

shogun_labs / module-shogun-page-builder

Maintainers

Details