Installation
Mall can be found on the official October CMS Marketplace.
Using Marketplace
The easiest way to install Mall is via the official Marketplace. There you can add the plugin to your project and install it by executing the following artisan command in the root directory of your website:
php artisan project:sync
During this installation, all dependencies are downloaded and installed automatically.
Manual Installation
You can install Mall also manually like any other OctoberCMS plugin. However, make sure that you install the dependencies up-front. Visit the root directory of your OctoberCMS website and execute the following commands
php artisan plugin:install RainLab.User
php artisan plugin:install RainLab.Location
php artisan plugin:install RainLab.Translate
php artisan plugin:install OFFLINE.Mall
You can also use composer to install the plugins, however, keep in mind that you've to install and migrate the dependent packages first before installing and migrating Mall itself.
composer require rainlab/user-plugin
composer require rainlab/location-plugin
composer require rainlab/translate-plugin
php artisan october:migrate
composer require offline/oc-mall-plugin
php artisan october:migrate
Both ways will automatically install all composer packages required by the Mall plugin, at least on OctoberCMS v3 installations.
Optional Dependencies
Certain features of the Mall plugin requires you to install additional composer packages to make everything work.
Feature | Package |
---|---|
File-Based Index | offline/jsonq tmarois/filebase |
Google Merchant Feed | vitalybaev/google-merchant-feed |
PostFinance Payment Provider | bummzack/omnipay-postfinance |
Simple use the following command in the root directory of your OctoberCMS website to install the desired package.
composer require <$package_name>
Check your Installation
After you successfully installed all plugins and packages, you can run the mall:check
artisan command to validate your installation.
Don't panic! After the initial installation there will be some items that are marked as FAIL. This is because we didn't configure the plugin yet.
php artisan mall:check
TIP
You can run this command at any time in the future to make sure everything is set up correctly.
Seed initial data
Since version 3.1, Mall no longer inserts any data automatically during the installation. You can use the following command to seed the initial data, as happened before.
php artisan plugin:seed OFFLINE.Mall OFFLINE\Mall\Updates\Seeders\MallSeeder
However, we highly recommend using the following command instead, which allows you to customize the desired data.
php artisan mall:seed --help
DANGER
Please note that this command deletes all existing store data and resets all setting. You should therefore not run this command on an already configured installations.
You can also simple reset the whole Mall installation by running the following command.
php artisan plugin:refresh OFFLINE.Mall
Setup Demo-Theme
We also provide a simple demonstration theme to make getting started with our Mall plugin as easy as possible. You can find this theme on the official October CMS Marketplace as well as on GitHub.
To install the theme, make sure you've installed the dependent packages first
php artisan plugin:install RainLab.Pages
php artisan plugin:install OFFLINE.SiteSearch
After that, you can download and extract the theme inside the themes/mall
folder of your OctoberCMS website and select it as your active theme.