Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

MageSuite documentation is under refactor and update phase.

MageSuite is a Magento 2 extension ecosystem providing UX/performance improvements and many new features.

Demo

Short video presentation of the Content Constructor feature:

https://vimeo.com/229095695

Other features are presented as part of our User guide.

User guide

The user guide of MageSuite features can be found here.

Some of extensions presented in User Guide are optional and not included in the main MageSuite Metapackage. You might need to install them separately.

List of available modules

Basic MageSuite modules are a part of MageSuite metapackage, but MageSuite offers plenty of optional modules that can be added separately.

Module’s documentation is under refactor and construction, available module docs can be found here Modules

 List of all the Open Source MageSuite repositories

MageSuite Metapackage

"creativestyle/magesuite"

This is the main metapackage that you should install in order to get basic MageSuite installation into your Magento 2 setup:

https://github.com/magesuite/magesuite/blob/12.x/composer.json

Requirements

Magento version requirements depend on the MageSuite version used.
Check the Magento Versions compatibility table for reference.

The whole ecosystem depends on ElasticSuite and you need an ElasticSearch server in order to use it.

All of the frontend features and improvements are implemented in theme-creativeshop. You won't be able to take advantage of them if you use Luma or other custom themes.

WARNING! We do not support "easy"/"zip" Magento installations. MageSuite supports only the composer way of setting up Magento.

Installation

TIP It's advised you either have Elasticsuite (version 2.10.x) already installed and running. If you don't then this package will install it and you must have elasticsearch up and running on localhost:9200 prior to executing the setup:upgrade or it will fail.

Building theme-creativeshop

theme-creativeshop requires Node ^14.0.0 and Yarn

MageSuite theme does not rely on Magento for building the assets, instead, it uses gulp and webpack.

Before you start, make sure you have nodejs and yarn installed.

After the theme's composer package is installed on your Magento project, execute:

cd vendor/creativestyle/theme-creativeshop
yarn install
yarn build

It will build and place build artifacts into the app/design subfolder.

After the theme is built, clear your Magento cache and you should be able to select it in the admin.

Magento versions compatibility table

Magento version

MageSuite Package version

Breaking changes documentation

2.3.0-2.3.1

^2.0.0

2.3.2

^3.0.0

2.3.3

^4.0.0

2.3.4+

^5.0.0

2.4.0-2.4.1

^7.0.0

2.4.2

^8.0.0

2.4.2

^9.0.0

Breaking changes in Version 9

2.4.3

^10.0.0

Breaking changes in Version 10

2.4.4

^11.0.0

Breaking changes in Version 11

2.4.5

^12.0.0

Breaking changes in Version 12

2.4.6+

^13.0.0

  • No labels