Install via Composer

Download Php-Console and its dependencies to the vendor directory. You can use Composer for the automated process:

$ php composer.phar require splash/magento2

Composer will install the bundle to vendor/splash/magento2 directory.

Activate Splash Module from CLI

Now that module is installed, you have to activate it Magento CLI.

php bin/magento module:enable SplashSync_Magento2

Clear Cache & Restart your application

To ensure changes are done, you need to recompile and flush all cache.

php bin/magento setup:upgrade
php bin/magento setup:di:compile
php bin/magento cache:enable
php bin/magento cache:clean

Setup Splash Minimal Parameters from CLI

At this step, you should be able to see Splash Connector on your store config!

If, for any reasons, you have to programmatically setup Splash, see below minimal configuration values.

bin/magento config:set splashsync/core/id                               "ThisIsMagento2Key"
bin/magento config:set splashsync/core/key                              "ThisTokenIsNotSoSecretChangeIt"
bin/magento config:set splashsync/security/username                     "admin"

You want to try this module? Adjust it to your needs? Or develop new features? Ok! Let’s build a DEV environment!!

Using Docker & Docker Compose, you can start a full developer project.

For each module, we predefined most common possible installations.

Requirements on Local System

• Git git-scm.com
• Php Composer getcomposer.org/
• Docker & Docker-Compose www.docker.com/
• No active Splash Sync User Account is needed!

Clone Module Sources

First, you need to download the sources and compile the module locally.

$ git clone https://github.com/SplashSync/Php-Console myModule
$ cd myModule
$ composer install --no-dev

Build whole Docker Compose Environment

Then, just build the docker environment.

$ docker-compose up

This may take a while but in the end, you should have all your environment working!

Access your Environment

To facilitate access to your instances, we fixed all containers IPs on docker-compose.yml file.

In this file, you should find a comment with target IPs of your environment containers.

I.e. for Prestashop:

################################################################################
# Docker Compose File
#
# This Docker File intend to Create a Complete Dev Environment 
# for Splash Modules on Prestashop
#
# To us different PS Version coinfigured, you need to add hosts to /etc/hosts
# 
# 172.102.0.10        latest.prestashop.local
# 172.102.0.16        ps1-6.prestashop.local
# 172.102.0.17        ps1-7.prestashop.local
# 172.102.0.100       toolkit.prestashop.local
#
################################################################################

So, if you browse IP 172.102.0.10, you should find your App working!!

All usefull details of the installtion are visible on docker-compose.yml file.

For an easier usage, you can cut/paste all IPs to your /etc/hosts. This will make the App available from Url, not only IP.

Test, Develop & Debug using our toolkit

Have you seen this last container available? It’s Splash ToolKit!!

It’s done for developpers and should already be pre-setuped for you Apps!

Just browse the url, and log with user “admin” and password “admin”!

Clear cache?

If your configuration changed, you may have a pretty error… you need to clear the cache!

How? Just run this docker command:

$ docker-compose exec toolkit rm -Rf var/cache/*

Test your connector locally??

Yes, you can! All you need to run our complete core test sequence is already provided by Splash Toolkit.

How? Just run phpunit using this docker command:

$ docker-compose exec toolkit vendor/bin/phpunit