Quick start

This guide helps you set up MiniShop3 quickly and create your first products.

System requirements

Requirement	Version
MODX Revolution	3.0.0+
PHP	8.1+
MySQL	5.7+ / MariaDB 10.3+
Composer	2.x

Dependencies

• pdoTools 3.x — for snippets and the Fenom template engine
• VueTools — Vue 3 and PrimeVue for the Manager interface
• Scheduler (optional) — for background tasks (import, notifications, cleanup)

Installation

Via MODX package manager

1. Connect our repository
2. Go to Packages → Installer
3. Select the Modstore.pro provider, click Download Extras
4. Find pdoTools, VueTools, Scheduler, and MiniShop3 in the catalog, one by one
5. For each package, click Download and Install

More installation methods are on the main documentation page.

What happens during installation

MiniShop3 automatically:

1. ✅ Creates database tables via Phinx migrations
2. ✅ Registers snippets, plugins, and chunks
3. ✅ Installs system settings with the ms3_ prefix
4. ✅ Creates default order statuses
5. ✅ Creates delivery and payment methods

Initial setup

1. Store service pages

Create the following pages:

1. Cart — place the msCart snippet
2. Checkout — place the msOrder snippet
3. Order placed — place the msGetOrder snippet
4. Customer account — place the msCustomer snippet with the profile service
5. Customer orders — place the msCustomer snippet with the orders service
6. Customer addresses — place the msCustomer snippet with the addresses service

Template examples for each page are in /core/components/minishop3/elements/templates/. For a quick start, copy the template markup as-is and adjust it to your design.

2. System settings

Go to System Settings and find settings in the minishop3 namespace (you can search for page_id):

Setting	Description
ms3_cart_page_id	ID of the cart page
ms3_order_page_id	ID of the checkout page
ms3_order_success_page_id	ID of the page the customer is redirected to after successful payment
ms3_order_redirect_thanks_id	ID of the "Thank you for your order" page
ms3_customer_login_page_id	ID of the customer login page (usually the same as the profile page)
ms3_customer_register_page_id	ID of the customer registration page (usually the same as the profile page)
ms3_customer_profile_page_id	ID of the customer profile page
ms3_customer_orders_page_id	ID of the customer order history page

The full settings list is on the System settings page.

3. Creating categories

1. Go to Resources
2. Create a new resource with Resource Type = Product category
3. Fill in the title, choose a template, and save

4. Creating products

1. In the category, click Add product
2. Enter the title, choose a template, and save
3. After saving, fill in the Product properties tab:
   • SKU
   • Price
   • Weight (optional)
   • Image
4. Save the product and check Published

Templates

For a quick start, the package includes ready-made templates you can copy entirely and then edit to match your design. Available templates:

• core/components/minishop3/elements/templates/catalog.tpl — Catalog
• core/components/minishop3/elements/templates/product.tpl — Product page
• core/components/minishop3/elements/templates/cart.tpl — Cart
• core/components/minishop3/elements/templates/order.tpl — Checkout
• core/components/minishop3/elements/templates/thanks.tpl — Thank you page
• core/components/minishop3/elements/templates/customer.tpl — Customer account

Checkout

For checkout to work, make sure Settings has at least one payment method and one delivery method.

Finally, check that the delivery method you use lists the required fields for your case. Usually phone, first name, last name, and sometimes email.

Next steps

• Snippets — full snippet reference
• Manager interface — Manager UI overview
• Frontend interface — site UI, templates, and chunks
• Frontend JavaScript — using JS on your site
• REST API — API integration
• Events — extending via plugins