Appearance

Mall October CMS Plugin ​

Welcome to the official documentation of the Mall plugin, the all-inclusive e-commerce solution for the Laravel-based OctoberCMS.

On the following pages you will find all the information you need to install the plugin on your website and integrate it in your used theme. You will also read about the individual models, controllers and how you can extend them to integrate your own functions.

NOTE

If you think, that some details are missing or not sufficiently well explained, we invite you to extend and add this to our documentation. For this case you will find an "Edit this page on GitHub" link at the bottom of each page, which brings you to the corresponding markdown file in our Github repository. Thanks for your help!

Requirements ​

We highly recommend using the latest OctoberCMS v3 and PHP v8 versions available, however, the following requirements represent the minimum needed to run Mall on your website.

  • OctoberCMS v2.2+ | v3.0+
  • PHP v7.4+ | v8.0+
  • MySQL v5.7+ | v8.0+ or MariaDB v10.2+ or SQLite* v3.19+

CAUTION

* Although it is possible to use Mall via SQLite, we strongly recommend using one of the other database systems, especially on a large number of products or customers.

Dependencies ​

Mall relies on the following official OctoberCMS Plugins, which must be installed before installing the Mall extension itself.

Mall also requires the following PHP packages, which should be installed automatically, when installing Mall via plugin:install or project:sync on OctoberCMS v3 installations.

Optional dependencies ​

The following dependencies are only required if necessary, but must be installed manually if needed.

Development dependencies ​

The following dependencies are only required when developing or extending the Mall plugin itself, and must be installed manually as well, of course.