Skip to content

Latest commit

 

History

History
142 lines (115 loc) · 5.21 KB

install.md

File metadata and controls

142 lines (115 loc) · 5.21 KB
Raw
description
Learn the steps needed in order to install Umbraco Commerce into your Umbraco CMS website.

Installation

In this article, you will learn how to install Umbraco Commerce into your Umbraco CMS implementation.

Prerequisites

For system requirements, see the Requirements article.

Umbraco Commerce Installation

There are different ways to install Umbraco Commerce:

NuGet Package Installation

Umbraco Commerce is available via NuGet.Org.

To install Umbraco Commerce via NuGet:

  1. Run the following command in the NuGet Manager Console window:

    dotnet add package Umbraco.Commerce

  2. Restart the application using the following command:

    dotnet run

Visual Studio Installation

To install via Visual Studio, follow these steps:

  1. Open your project in Visual Studio.

  2. Go to Tools -> NuGet Package Manager -> Manage NuGet Packages for Solution...

  3. Browse for Umbraco.Commerce.

    Installing Umbraco Commerce via the NuGet Package Manager

  4. Select the appropriate version from the Version drop-down depending on the Umbraco version you are using.

  5. Click Install.

  6. Ensure that the package reference is added to the .csproj file once the installation is complete:

    <ItemGroup>
<PackageReference Include="Umbraco.Commerce" Version="14.x.x" />
</ItemGroup>

For most projects, you only need a single package to install Umbraco Commerce. But if your solution is more complex with multiple projects, Umbraco Commerce provides sub-packages to match different dependencies.

Sub-package Description
Umbraco.Commerce.Common A shared project of common, non-Commerce-specific patterns and helpers.
Umbraco.Commerce.Core Core Commerce functionality that doesn't require any infrastructure-specific dependencies.
Umbraco.Commerce.Infrastructure Infrastructure-specific project containing implementations of core Commerce functionality.
Umbraco.Commerce.Persistence.SqlServer Persistence-specific project containing implementations of core Commerce persistence functionality for SQL Server.
Umbraco.Commerce.Persistence.Sqllite Persistence-specific project containing implementations of core Commerce persistence functionality for SQLite.
Umbraco.Commerce.Web Core Commerce functionality that requires a web context.
Umbraco.Commerce.Cms Core Commerce functionality that requires an Umbraco dependency.
Umbraco.Commerce.Cms.Web The Commerce functionality for the Umbraco presentation layer.
Umbraco.Commerce.Cms.Web.Api A shared project of common API specific functionality.
Umbraco.Commerce.Cms.Web.Api.Management The backoffice Management API layer.
Umbraco.Commerce.Cms.Web.Api.Payment The Payment handling API layer.
Umbraco.Commerce.Cms.Web.Api.Storefront The frontend Storefront API layer.
Umbraco.Commerce.Cms.Web.UI The static Commerce assets for the Umbraco presentation layer.
Umbraco.Commerce.Cms.Startup The Commerce functionality for registering Commerce with Umbraco.
Umbraco.Commerce The main Commerce package entry point package.

{% hint style="info" %} If you encounter an SQLite error after installing Umbraco Commerce, you may need to enable SQLite support. For more information, see the Configure SQLite support article. {% endhint %}

Installing a License

For details on how to install a license, see the Licensing article.

Using Umbraco Commerce

Once Umbraco Commerce is installed, you can find it in the Umbraco backoffice under the Settings and Content sections. To access the Commerce section, additional configuration is required. For more details, see the Configuration article.