Create a new module

The section explains how to create a new Virto Commerce module.

Prerequisites

Virto Commerce uses dotnet new command to create a Virto Commerce module project based on a template.

Run command to install Virto Commerce template.

dotnet new --install VirtoCommerce.Module.Template

To create a new Virto Commerce module project from template:

Run command.

dotnet new vc-module --ModuleName CustomerReviews --Author "Jon Doe" --CompanyName VirtoCommerce

The command calls the template engine to create the artifacts on disk based on the Virto Commerce template and options.

Options	Description	Type	Required	Default value
--Author (or -A)	Your name	string	Optional	John Doe
--CompanyName (or -C)	Your company name	string	Optional	VirtoCommerce
--ModuleName (or -M)	Your module name	string	Optional	newModule
--PlatformVersion (or -P)	Required Platform Version	string	Optional	3.800.0
--PlatformNuGetPackageVersion (or -Pl)	Required Platform NuGet Package Version	string	Optional	3.800.0

Virto Commerce CLI should be used to build, test and create a module package.

Note

Also you can open solution in Visual Studio and use Visual Studio tools to build the module.

As a result you can find the module package in artifacts folder.

The module package can be uploaded and installed to the Virto Commerce Platform.

If the module is installed properly, you should see the new module in the list of installed modules, Admin UI and Swagger API.