Virto Commerce Module Templates for Dotnet New

This repository contains dotnet new templates for Virto Commerce Modules.

Templates

• vc-module - Creates a new Virto Commerce module.
• vc-module-xapi - Creates a new Virto Commerce module with XAPI support.
• vc-module-dba - Creates a new Virto Commerce module with DB Agnostic support.

Getting Started

Install

To get started, first install the templates:

dotnet new install VirtoCommerce.Module.Template

How to create a new module from template

• Open Windows PowerShell CMD
• Navigate to your sources folder
• Run command

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

where --ModuleName is your module name, --Author is your name, and --CompanyName is your company name

• vc-module-customer-reviews folder with module solution will be created
• You can pass PlatformVersion attribute to create a new module for specific version of Virto Commerce.

How to create a new XAPI module from template

There is a seprate template named vc-module-xapi for an XAPI module.

• Open Windows PowerShell CMD
• Navigate to your sources folder
• Run command

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

Parameters description

Default values based on latest Stable 8 Release

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)	Virto Commerce platform version	string	Optional	3.800.0
--XapiVersion (or -X)	XAPI module version	string	Optional	3.800.0

How to uninstall

Run dotnet to uninstall templates

dotnet new uninstall VirtoCommerce.Module.Template

How to contribute

Install templates locally

• Open Windows PowerShell CMD
• Clone repository

git clone https://github.com/VirtoCommerce/vc-cli-module-template

• Install downloaded templates

dotnet new install vc-cli-module-template\templates

How to uninstall locally installed templates

• Run command

dotnet new uninstall <full or relative path to the templates directory>

License

Copyright (c) Virtosoftware Ltd. All rights reserved.

Licensed under the Virto Commerce Open Software License (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://virtocommerce.com/open-source-license

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.