Installation

Installing Vendr Checkout, an add-on package for Vendr, the eCommerce solution for Umbraco v8+

There are currently two ways to install the Vendr Checkout package for Vendr into your solution. Using the Umbraco package distribution, installed via the Umbraco back-office, or using our NuGet packages, installed directly into your projects code base via the NuGet Package Manager.

Umbraco Package Installation

To install the Vendr Checkout Umbraco package, you will need to download the package file manually from the Vendr package page on the Umbraco Developer Portal. On this page, scroll down to the Package Files section and locate the Vendr Checkout package, clicking it to initiate a download.

Umbraco package files list

Once downloaded you should manually install the package by uploading it to the local package installer located in your back-office Packages > Install Local section. Once uploaded, follow the on-screen instructions provided to complete the install.

Installing an Umbraco Package via Local Umbraco Package

NuGet Package Installation

To install the Vendr Checkout package via NuGet you can run the following command directly in the NuGet Manager Console window:

PM> Install-Package Vendr.Checkout

Alternatively, you can also find and install the NuGet package via the NuGet Package Manager GUI.

Installing Vendr Checkout via the NuGet Package Manager GUI

Content Installation

When Vendr Checkout is installed, all relevant database configurations automatically occur via Umbraco Migrations, however there are a series of content creation steps that need to be triggered manually as these types of migrations are not supported by the Umbraco migrations system.

To install the relevant Vendr Checkout content (mainly the checkout content doc types + pages and updates to the Vendr store configuration) navigate to the Settings section and locate the Vendr Checkout dashboard in the root of the section.

Vendr Checkout Dashboard

On this dashboard, click the Install button then in the dialog select your site root node which is configured with a Vendr store picker linked to a Vendr store and then click Install

Vendr Checkout Dashboard

During this install, Vendr checkout will perform the following tasks:

  1. Create the Vendr Checkout Data Types (Colour picker and checkout step picker)
  2. Create the Vendr Checkout Document Types (Checkout page and checkout step page)
  3. Create the Vendr Checkout content nodes beneath the select site root node (unpublished)
  4. Configure the Vendr store with custom Vendr Checkout email templates and required payment providers

Upgrading

Before you upgrade

Before upgrading, it is always advisable to take a complete backup of your site/database. Every effort has been made to ensure that Vendr Checkout will upgrade gracefully, but there is always a risk that something may not install as expected.

Vendr Checkout used a combination of database migrations and a manual install dashboard for both installs and upgrades. Upgrading is generally a case of installing the latest version of the top of the existing package and running through the installation steps again.

Edit this page on GitHub

Site + logo design © 2020 Outfield Digital Ltd. Content contributions licensed under MIT.
Vendr® is a Registered Trademark of Outfield Digital Ltd.