Shopkit for Kirby

Shopkit is a comprehensive commerce solution for the excellent Kirby CMS.

Documentation available at shopkit.samnabi.com/docs.

Features

Products & shop settings

Easy product variants and options (e.g. sizes and colours)
Flexible shipping rates (Flat rate, per item, by weight, or by total price)
Related products
Inventory control
Discount codes (site-wide and product-specific)
Gift certificates
Control shipping & tax rates by country, with product-specific exceptions
Built-in SEO for rich snippets using RDFa structured data
Colour & background options

Payments & orders

Process payments with PayPal and Stripe (it's easy to add other payment gateways)
Let certain users pay later
Manage pending, paid, and shipped orders
Send order notifications to your shipping manager
Automatic PDF invoices

User experience

Multi-language setup (English, French, and German included by default)
No sign-up required (Orders are tied to PayPal email address)
Browse products in a grid or slideshow
Beautiful search layout

Roadmap

Keep tabs on the issues page to see what's planned for the future. Please add a new issue to report any bugs or request new features.

Pricing

You can try Shopkit for free on your local machine or a test server, forever. Once you're satisfied, buy a Shopkit license for $19 USD to use it on a public site.

Since Shopkit runs on the Kirby CMS, you'll also have to buy a Kirby license from Bastian.

Installation

Shopkit, just like Kirby, does not require a database, which makes it very easy to install. Just copy the files to your server and visit the URL for your website in the browser.

Please check if the invisible .htaccess file has been copied to your server correctly

Download ZIP

Download the latest version of Shopkit from the releases page.

Clone with Git

If you are familiar with the terminal, you can clone Shopkit from GitHub.

git clone --recursive https://github.com/samnabi/shopkit.git

Update

Use these terminal commands to update Shopkit and all its dependencies to the latest commit in the master branch.

# Update Shopkit
git checkout master
git pull

# Update dependencies
git submodule update --init --recursive
git submodule foreach --recursive git checkout master
git submodule foreach --recursive git pull

Configuration

Most of Shopkit's configuration happens in the shop page, located at /content/1-shop/shop.en.txt. This includes defining your shipping methods, tax rates, user permissions, and payment details.

Your shop logo and theme options are defined in the site options, located at content/site.en.txt.

Of course, there are helpful blueprints so you can easily manage everything from the panel.

Before your site goes public, you'll need to enter your license keys in the site/config/config.php file.

To configure payment gateways, edit the config.php files located in site/plugins/shopkit/gateways. As of v1.1, payment gateways cannot be configured from the Panel.

Upgrading notes

From v1.0.5

If you're upgrading from Shopkit 1.0.5 or earlier, note that there are 2 new pages under content/1-shop. The new folder structure looks like this:

content/
    1-shop/
        cart/
        confirm/          # new page
        countries/
        orders/
        terms-conditions/ # new page

From v1.0.3

If you're upgrading from Shopkit 1.0.3 or earlier, note that the location of the Register page has changed, and a new page called Reset has been introduced. The new folder structure looks like this:

content/
    account/
        register/
        reset/

From v0.9.2

If you're upgrading from Shopkit 0.9.2 or earlier, you'll have to change some things manually:

The old Shop page was located at /content/3-shop. It has now been changed to /content/1-shop. After pulling the updated repo, move your categories and products from 3-shop to 1-shop, then delete the 3-shop directory.
Since Shopkit is now multilingual, change all your text filenames to something like .en.txt.
In every product's text file, change Prices: to Variants:.
In every order's text file, change the order status values to reflect the new values: pending, paid, or shipped.

Changelog

v1.1

Bug fixes
- Fix locale-based formatting issues with PayPal gateway
- Fix inventory counting errors
- Better handling of non-float values in formatPrice()
- More reliable shipping calculation
- More reliable country detection
New features
- 💳 Stripe payment gateway
- 🛍 Gift certificates
- ⬇️ Downloadable products
- 🍪 Per-product tax rules
- 📗 Terms and conditions
Design and UI
- Filter orders by status on View Orders page
- Remember current page on login
- Larger photo slider on product page
- More detailed order notification emails
- Confirm customer name, email, and address after payment
Added robots.txt
Most template, snippet and blueprint files moved to plugins folder
Standardized payment gateway structure
Moved blueprints to YAML format
Updated core and panel to Kirby 2.3.2

v1.0.5

Bug fixes
- Even more reliable calculation of shipping rates, subtotals, and applicable tax
- New order notifications now work with PayPal and are multilingual
- Fix the missing PayPal redirection message
Design and UI
- Minor tweaks to "Free Shipping" and "No Tax" badge placement in the Cart page
Replace several nested git repos with regular files for the DomPDF plugin, for easier installation

v1.0.4

Bug fixes
- More reliable calculation of shipping rates
- Prevent DOM manipulation of discount and tax amounts in the cart
- Prevent cart localization errors (resulting in NaN for the cart total)
- Add multi-language support to some hard-coded strings (thanks to concertimpromptu)
- Remember the selected country when a user navigates away from the Cart page (thanks to concertimpromptu)
- Fix errors with subdirectory installs
- Prevent prices from carrying over to the next product where prices haven't yet been set
New features
- 💸 Discount codes (site-wide and per-product)
- 🔑 Password reset
- 👮 Opt-in email verification for new accounts
- 📦 Order notification emails
- 🤑 More robust "pay later" options
Design and UI
- Moved login form lower in the sidebar
- Better indication of failed login
- Make it harder to accidentally delete your account
- Better handling of thumbnails with different aspect ratios (burry background fills up the dead space, like instagram)
- Minimum 150px width for listing items
- Removed title for the search bar
- Better icons for Category and Product pages in the panel
- Better UI for drag-and-drop file uploads in the panel
- Smarter top menu layout (adapts to the number of menu items)
German language option (thanks to medienbaecker)
- Also apologies to medienbaecker for my terrible google translate on the remainder of the German strings
Switched to dompdf for generating PDF Invoices (allows for easier HTML layout)
Moved page logic into controllers
RTL text support in templates
Explicit timezone definition in config.php
Smarter onboarding notifications
Hidden honeypot form fields for spam protection
Removed wholesaler user role (preferential pricing now handled with discount codes instead of roles)
Auto-shrink large image uploads

v1.0.3

Bug fixes
- Fixed login redirect on subfolder installs
- Removed incorrect help text from Register page
Theme options
- Choose custom colours (Shopkit adjusts brightness to ensure readability)
- Background colour & image options, including blurred background
Panel improvements
- Improved UI for selecting images
- Numeric field validation within structure fields
- Tabbed layout to organize site options and shop settings
Added Brand as a default product field (helps with Google rich data snippets)
Added hours of operation to the Contact page as a separate field
Added Related products to the Default template
Stylish photo slider for most templates
Updated admin navbar with new icons and Design button for theme options
Added currency code (e.g. USD) to Cart page for clarity
Set currency to $USD by default
Friendlier error page text
Sidebar sections are hidden if content is not populated (i.e. categories, contact info)

v1.0.2

Improved reliability for PayPal transaction confirmation
User registration has one name field instead of separate first/last name fields
Fixed shipping bug related to updated multiselect syntax
Clearer instructions when logging in from /panel
Add some padding to the bottom of

v1.0.1

Upgrade Kirby core & panel to 2.2.3
Panel improvements
- Template-specific icons in the sidebar
- Protect core pages from deletion
- Autopublish for all templates
- Some structure fields display in table format
Add Schema.org RDFa data to product templates so rich snippets show up in Google & Bing
Support for installing Shopkit in a subdirectory
Add Shop settings button in the admin bar
Bugfixes & layout tweaks

v1.0

Inventory control
New payment logic to support multiple gateways (PayPal only for now, but you can easily add your own)
Browse products in slideshow view
Onboarding prompts to help new users set up shop options and create their first product
Multi-language setup (English and French available right now)
New pages visible by default (thanks to the Kirby Auto Publish plugin)
Visual markdown editor
Admin menu for logged-in users
New theme
- Leaner, modular CSS
- Minimalist design for easy customization
- More flexible gallery layout (images of all aspect ratios look great)
- Thumbnail previews in cart
Other changes
- Use email instead of username to log in
- Improved order flow (orders are logged even if user doesn't return from PayPal)
- Shop is the homepage by default
- Order statuses changed to "Pending", "Paid", or "Shipped"
- Bugfix: Allow multiple options of a variant in the cart
- Bugfix: Cart stuck in PayPal sandbox mode
- Security fix: Rewritebase vulnerability

Issues and feedback

If you have a GitHub account, please report issues and post feedback on the issues page.

Otherwise, send me an email: sam@samnabi.com

Contributors

Thanks to Thomas Günther for making the German translation.

Thanks to CelineDesign for transitioning Shopkit to object-oriented code in version 0.9.1.

Thanks to the following beta testers for getting Shopkit to version 1.0: dsply, distantnative, malvese, texnixe, flowfx, aftereffectsmagic

aguynamedirvin/shopkit