Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions 14/umbraco-commerce/.gitbook.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,6 @@ how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-prov
how-to-guides/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout: upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md
how-to-guides/migrate-from-vendr-to-umbraco-commerce/README: upgrading/migrate-from-vendr-to-umbraco-commerce/README.md
key-concepts/events: key-concepts/events/README.md
getting-started/introduction: getting-started/requirements.md
installation/install: getting-started/install.md
installation/the-licensing-model: getting-started/the-licensing-model.md
2 changes: 1 addition & 1 deletion 14/umbraco-commerce/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description: >-

Umbraco Commerce is the official Umbraco e-commerce addon for your Umbraco CMS website. It can be used to set up small webshops, while it can also be implemented for big-scale e-commerce solutions spanning multiple countries.

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="https://docs.umbraco.com/umbraco-commerce/v/10.commerce.latest/getting-started/introduction"><strong>Getting Started</strong></a></td><td>Find all the information you need to get started using Umbraco Commerce with your Umbraco CMS implementation.</td><td><a href="getting-started/introduction.md">introduction.md</a></td><td><a href=".gitbook/assets/commerce-icon.png">commerce-icon.png</a></td></tr><tr><td><a href="https://docs.umbraco.com/umbraco-commerce/v/10.commerce.latest/how-to-guides/overview"><strong>How-to Guides</strong></a></td><td>Looking to configure and implement something specific? Take a look through the How-to section where you might find a guide that fits your needs.</td><td><a href="how-to-guides/overview.md">overview.md</a></td><td><a href=".gitbook/assets/umbraco_free_way_01.png">umbraco_free_way_01.png</a></td></tr><tr><td><a href="https://docs.umbraco.com/umbraco-commerce/v/10.commerce.latest/key-concepts/overview"><strong>Key Concepts</strong></a></td><td>Looking to learn more about the different concepts and features of Umbraco Commerce? You can find detailed information about each of them in this section.</td><td><a href="key-concepts/overview.md">overview.md</a></td><td><a href=".gitbook/assets/Umbraco_Brand_Guidelines_2020_28_Illustration blocks.png">Umbraco_Brand_Guidelines_2020_28_Illustration blocks.png</a></td></tr></tbody></table>
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td><a href="getting-started/requirements.md"><strong>Install Umbraco Commerce</strong></a></td><td>Find all the information you need to get started using Umbraco Commerce with your Umbraco CMS implementation.</td><td><a href="getting-started/requirements.md">requirements.md</a></td><td><a href=".gitbook/assets/commerce-icon.png">commerce-icon.png</a></td></tr><tr><td><a href="https://docs.umbraco.com/umbraco-commerce/v/10.commerce.latest/how-to-guides/overview"><strong>How-to Guides</strong></a></td><td>Looking to configure and implement something specific? Take a look through the How-to section where you might find a guide that fits your needs.</td><td><a href="how-to-guides/overview.md">overview.md</a></td><td><a href=".gitbook/assets/umbraco_free_way_01.png">umbraco_free_way_01.png</a></td></tr><tr><td><a href="https://docs.umbraco.com/umbraco-commerce/v/10.commerce.latest/key-concepts/overview"><strong>Key Concepts</strong></a></td><td>Looking to learn more about the different concepts and features of Umbraco Commerce? You can find detailed information about each of them in this section.</td><td><a href="key-concepts/overview.md">overview.md</a></td><td><a href=".gitbook/assets/Umbraco_Brand_Guidelines_2020_28_Illustration blocks.png">Umbraco_Brand_Guidelines_2020_28_Illustration blocks.png</a></td></tr></tbody></table>

## Extend Umbraco Commerce

Expand Down
23 changes: 10 additions & 13 deletions 14/umbraco-commerce/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,13 @@
* [Commerce Payment Providers](https://docs.umbraco.com/umbraco-commerce-payment-providers)
* [Commerce Shipping Providers](https://docs.umbraco.com/umbraco-commerce-shipping-providers)

## Installation
## Getting Started

* [Installing Umbraco Commerce](installation/install.md)
* [Licensing](installation/the-licensing-model.md)
* [Requirements](getting-started/requirements.md)
* [Installation](getting-started/install.md)
* [Licensing](getting-started/the-licensing-model.md)
* [Configuration](getting-started/umbraco-configuration.md)
* [User Interface](getting-started/user-interface.md)

## Upgrading

Expand All @@ -23,12 +26,6 @@
* [Migrate Umbraco Commerce Checkout](upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-umbraco-commerce-checkout.md)
* [Migrate custom Payment Providers](upgrading/migrate-from-vendr-to-umbraco-commerce/migrate-custom-payment-providers.md)

## Getting Started

* [Introduction](getting-started/introduction.md)
* [Umbraco Configuration](getting-started/umbraco-configuration.md)
* [User Interface](getting-started/user-interface.md)

## How-To Guides

* [Overview](how-to-guides/overview.md)
Expand Down Expand Up @@ -78,10 +75,6 @@
* [Umbraco Commerce Builder](key-concepts/umbraco-commerce-builder.md)
* [Webhooks](key-concepts/webhooks.md)

## Tutorials

* [Overview](tutorials/overview.md)

## Reference

* [Stores](reference/stores/README.md)
Expand All @@ -103,3 +96,7 @@
* [Content](reference/storefront-api/endpoints/content.md)
* [Management API](reference/management-api/README.md)
* [Go behind the scenes](reference/go-behind-the-scenes.md)

## Tutorials

* [Overview](tutorials/overview.md)
Original file line number Diff line number Diff line change
Expand Up @@ -7,23 +7,56 @@ description: >-

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

You can also find information about how to upgrade, install, and activate your Umbraco Commerce license.
## Prerequisites

## NuGet Package Installation
For system requirements, see the [Requirements](../getting-started/requirements.md) article.

## Umbraco Commerce Installation

There are different ways to install Umbraco Commerce:

- [NuGet Package Installation](#nuget-package-installation)
- [Visual Studio Installation](#visual-studio-installation)

### NuGet Package Installation

Umbraco Commerce is available via [NuGet.Org](https://www.nuget.org/packages/Umbraco.Commerce/).

To install Umbraco Commerce via NuGet, run the following command directly in the NuGet Manager Console window:
To install Umbraco Commerce via NuGet:

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

```bash
dotnet add package Umbraco.Commerce
```

2. Restart the application using the following command:

```bash
dotnet add package Umbraco.Commerce
```
```bash
dotnet run
```

Alternatively, you can also find and install the NuGet package via the NuGet Package Manager in Visual Studio. You will see a number of packages available, however, you will want to install the main **Umbraco Commerce** package.
### Visual Studio Installation

![Installing Umbraco Commerce via the NuGet Package Manager](../media/nuget-packages-overview.png)
To install via Visual Studio, follow these steps:

For most sites using a single solution, the above will be all you need to install Umbraco Commerce into your project. When you have a more complex solution structure consisting of multiple projects, Umbraco Commerce is available in multiple sub-packages with varying dependencies.
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](../media/v14/nuget-package-overview.png)

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:

```cs
<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.

<table>
<thead>
Expand Down Expand Up @@ -102,4 +135,8 @@ If you encounter an SQLite error after installing Umbraco Commerce, you may need

## Installing a License

See the [Licensing page](the-licensing-model.md#installing-your-license) for details on how to install a license.
For details on how to install a license, see the [Licensing](../getting-started/the-licensing-model.md) 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](../getting-started/umbraco-configuration.md) article.
25 changes: 0 additions & 25 deletions 14/umbraco-commerce/getting-started/introduction.md

This file was deleted.

25 changes: 25 additions & 0 deletions 14/umbraco-commerce/getting-started/requirements.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
description: Getting Started with Umbraco Commerce.
---

# Requirements

In this article, you will find the key steps needed to get started with Umbraco Commerce.

It is assumed that you have an Umbraco 14+ website configured and ready for the Umbraco Commerce installation.

{% hint style="info" %}
For detailed instructions on installing the latest version of Umbraco, refer to the [Umbraco CMS documentation](https://docs.umbraco.com/umbraco-cms/fundamentals/setup/install).
{% endhint %}

## System Requirements

The minimum requirements for using Umbraco Commerce are:

* Umbraco CMS version 14+
* SQL Server 2015+ Database
* **SQLite** is acceptable for testing but not recommended for live deployments. For more details, see the [Configuring SQLite support](../how-to-guides/configure-sqlite-support.md) article.

## Versioning

Umbraco Commerce is an add-on product for Umbraco CMS and follows the [versioning strategy outlined for Umbraco CMS](https://umbraco.com/products/knowledge-center/versioning-and-release-cadence/).
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
description: Configuring Umbraco for Umbraco Commerce.
---

# Umbraco Configuration
# Configuration

Before you can start to use Umbraco Commerce, you need to configure Umbraco to allow access to the relevant sections. The Umbraco Commerce UI is split over three sections within the Umbraco backoffice:

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
9 changes: 7 additions & 2 deletions 14/umbraco-commerce/tutorials/overview.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,13 @@
---
title: Tutorials
description: Step-by-Step Tutorials on getting started with Umbraco Commerce.
---

# Overview

In this section, we will provide a series of follow-along tutorials on how to implement Umbraco Commerce. These will be aimed at getting you set up and running without going into heavy theoretical details. Once you are familiar with working with Umbraco Commerce, you can use the other sections of the documentation to gain a more in-depth knowledge of the different things you'll have implemented.
In this section, we offer a series of step-by-step tutorials to help you implement Umbraco Commerce. These guides focus on practical setup and configuration, avoiding complex theoretical details.

Once you are comfortable with the basics of Umbraco Commerce, use the documentation to explore advanced features and deepen your understanding of Umbraco Commerce.

{% hint style="warning" %}
We are crafting new tutorials to guide you through Umbraco Commerce. Stay tuned for some practical guides coming your way. If you have any suggestions, share them using the **Feedback** option.
{% endhint %}