README

MageSetup configures a shop for a national market.

Currently supported countries are:

Austria (at)
Switzerland (ch)
Germany (de)
Spain (es)
France (fr)
United Kingdom (gb)
Italy (it)
Netherlands (nl)
Poland (pl)
Romania (ro)
Russia (ru).

More countries to follow.

Missing your country? Please open a pull request with the necessary configuration for your country and help us support more countries.

Requirements

PHP >= 7.3
Magento >= 2.4.3

If you are using Magento < 2.4.3, you can still use version 0.4.*.

Installation

Via composer (recommended)

Please go to the Magento2 root directory and run the following commands in the shell:

composer require firegento/magesetup2
bin/magento module:enable FireGento_MageSetup
bin/magento setup:upgrade

Manually

Please create the directory app/code/FireGento/MageSetup and copy the files from this repository to the created directory. Then run the following commands in the shell:

bin/magento module:enable FireGento_MageSetup
bin/magento setup:upgrade

Usage

bin/magento magesetup:setup:run <country_code> <processors>

Parameters:

<country_code> is a required argument. Please find available country codes in country list above (e.g. de for Germany).
<processors> is an optional argument. If no processor code is given, all processors will be run.

Available processors:

agreements for setting up the terms and conditions
cms for setting up all required cms pages and cms blocks
systemConfig for setting up base configuration values.
tax for setting up the base tax rules / tax rates.

Example:

Run all processors for Germany:

bin/magento magesetup:setup:run de

Only run agreements and cms for Germany:

bin/magento magesetup:setup:run de agreements cms

Hyvä Themes

If you're using Hyvä as frontend in your Magento 2 instance, please install the corresponding compatibility module. You can find all detailed installation instructions in the compatibility module repository.

Support

If you encounter any problems or bugs, please create an issue on GitHub.

Contribution

Any contribution to the development of MageSetup is highly welcome. The best possibility to provide any code is to open a pull request on GitHub.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!

Developer

FireGento Team

Website: http://firegento.com
Twitter: @firegento

Maintainer

@sprankhub
@frostblogNet
@Schrank
@therouv

Licence

GNU General Public License, version 3 (GPLv3)

firegento / magesetup2

Maintainers

Details