Getting Started

Getting started with Surevelox OrchardCore Modules is easy. All modules published on nuget are fully functional and free to evaluate in non-commercial environment. However these packages are protected by evaluation license. The trial is valid for 30 days.

Create

If you already have Orchard Core host project, proceed to Install. Otherwise, create OrchardCore CMS host project using Orchard Core templates a following

dotnet new occms

To learn more about Orchard Core code generation templates (opens new window) read the docs.

Install

To install any module,

• Create new OrchardCore host project or use existing.
• Add Nuget package reference of the desired module in the host project.
• If needed, optionally add Nuget package reference of dependent modules.
• Enable features via recipe or Feature management UI.

Using .NET CLI

dotnet add package [Module] --version [version]

Replace the [Module] with nuget package. For example to install DevicePreview module run following command

dotnet add package Surevelox.OrchardCore.Licensing --version 1.3

Using Package Reference in .csproj

<PackageReference Include="[Module]" Version="[version]" />

Replace the [Module] and [version] with nuget package and version of module you are installing. For example to install DevicePreview

<PackageReference Include="Surevelox.OrchardCore.DevicePreview" Version="1.3" />

Enable

Using Feature Management UI

To enable the features, login to OrchardCore site as administrator. In Admin dashboard, from navigation menu, select Configuration > Features. Now, search for the feature you want to enable by name (e.g. Device Preview.). Next to the desired feature, click on Enable button to enable the feature.

Using Recipe Step

Add feature recipe step with features you want to enable. For example, to enable DevicePreview feature in recipe use following.

{
    "name" : "feature",
    "enable": [
        "Surevelox.OrchardCore.DevicePreview"
    ]
}

To learn more about Orchard Core Recipes (opens new window) read the docs.