Quick Start Guide
miniShop2 is a free add-on for MODX Revolution that was originally developed by Basil Naumkin (aka Bezumkin.)
Since it was originally developed in Russia, some users have had difficulties translating the quick start guide and video. Hopefully this helps clear things up for other developers.
Table of Contents
- Getting Started
- Setting Up PayPal
- Component Settings
- Additional System Settings
- Media Sources
- Templates Required
- Pages Required
- Additional Notes
Install miniShop2 & pdoTools in Package Management. miniShop2 will try to automatically download and install pdoTools, though if it fails, make sure it is also added. You will also need phpThumbOf in order to use thumbnails.
Setting Up PayPal
- Login to PayPal
- Go to My Settling Tools (Under Profile)
- Setup API Permissions
- Enable Express Checkout
- Go back to API Setup / Request API Credentials / Request Signature (Option 2)
- Copy credentials into MODX System Settings > minishop2 (See below in Additional System Settings)
Create Payment Types (PayPal / CC, Check / Money Order, Cash, etc.)
Create Deliveries (Ground shipping, pickup, etc.) and choose what payment types are allowed for each
Statuses, Vendors, and Links of Goods are all optional features.
Make sure Friendly URLs are enabled. Otheriwse it won't work at the checkout.
Developers for US sites most likely need to change the formatting options of the prices, weight, and dates.
[2, ".", ","]
[3, ".", ","]
%m/%d/%y <span class="gray">%H:%M</span>
Add PayPal User, Password, and Signature from PayPal's API Credentials
Cancel & Success IDs
Set to the appropriate pages created
If you use media sources for your products, be sure to set the ID of your default media source.
Add msProducts Snippet to template
Add msProduct.content Chunk to template
Cart, Payment, Success, and Cancelled pages can all be basic text pages with the snippet added to the content (or in custom templates if you prefer.) Be sure to disabled richtext.
Create Products Category container with the custom class and the "Category" template. This works similar to Shaun McCormick's "Articles" container.
Add a product or two. This also works like Articles, with a few different options.
- Price: Add current price of product
- Old Price (Optional): Add old price of product
- Weight (Optional): If you figure in shipping costs, add the weight of each individual unit.
- Article (Optional): This is if you have any blogs or other pages attached to it.
Add msCart Snippet to Cart template. Create a page where your cart / summary of products will go. You'll need to a link to the payment page. You can create a custom chunk for the outer wrapper (tplOuter) or listed item (tplRow.) Default chunks are installed under the "miniShop2" chunk category.
Add msOrder Snippet
No snippets required
No Snippets required
miniShop2 cannot be installed in sub-directories without some modifications.