Type
library
Staempfli AG Magento2 Builder Tool
library
GPL-3.0
None
None
None
None
None
Tool to automatically build Magento2 projects and sync data from remote servers
composer require --dev "staempfli/magento2-builder-tool":"~1.0"
To use sync
capabilities, this tool requires that n98-magerun2 is installed in your project:
composer require "n98/magerun2":"^1.4"
cp -r <vendor_path>/staempfli/magento2-builder-tool/config.sample/ config
core_config_data
settings on config/mg2-builder/magento/config.yaml
config.sample/mg2-builder/server/config.yaml
NOTE: You only need to replace parameters between <>
with your corresponding values. All other placehoders like ${}
or {{}}
will be automatically replaced during the tool execution
mkdir logs
vim logs/.gitignore
# Ignore everything in this directory
*
# Except this file
!.gitignore
You can customise all properties according to your needs:
config/mg2-builder/project.properties
have the highest priority and will overwrite default onesList available targets:
bin/mg2-builder -l
Project install:
bin/mg2-builder install
Sync data from server:
bin/mg2-builder sync
If you are tired of writing over and over again some of the questions during the process, you can setup your default environment parameters as follows:
Create the folder _conf
one level higher than your project root.
Add a file called environment.properties
inside that folder.
Inside this file you can specify your default environment preferences as follows:
project.environment=<your_environment_type> (usually Local)
database.admin.username=<your_database_admin_user>
environment.server.type=<your_server_type> (apache or nginx)
environment.vhosts.dir=<your_preferred_vhost.d_path>
GNU General Public License, version 3 (GPLv3)
(c) 2016 Staempfli AG