Skip to content

Latest commit

 

History

History
113 lines (67 loc) · 4.54 KB

README.md

File metadata and controls

113 lines (67 loc) · 4.54 KB
Raw

TcOpen application templates

Maintenance GitHub license Open Source? Yes! dev

This repository contains templates for TcOpen applications, for you to get started quickly, with the development and deployment of your TcOpen applications.

Pre-requisites

For the specific requirements of a particular template see the readme of the template.

Add TcOpenGroup package feed

To get early access to the packages from TcOpen we advise you to get access to a dedicated package feed hosted on GitHub. If you do not have a GitHub account please consider creating one by signing up at https://github.com.

dotnet nuget add source --username <GITHUBUSERNAME> --password <PAT> --store-password-in-clear-text --name github-tcopen "https://nuget.pkg.github.com/TcOpenGroup/index.json"

How to create your Personal Access Token (PAT) read here.

Scaffolding from CLI

Installing

Infomation about versions are here

Latest public nuget.org release NuGet

Installing latest available version:

dotnet tool install TcOpen.tco --global --version --prerelease

Installing specific version:

dotnet tool install TcOpen.tco --global --version 0.3.0-preview.2

Updating to specific version

dotnet tool update TcOpen.tco --global --version 0.3.0-preview.2

Uninstalling global tool

dotnet tool uninstall TcOpen.tco -g

Get help

PS C:\> .\tco.exe --help

  -b, --branch-tag          Branch from which draw the scaffold.

  -n, --project-name        (Default: MyProject) Project name.

  -n, --template-name       (Default: mts-s-template) Name of the template from which the project will be scaffolded.

  -o, --output-directory    Target directory for the scaffold.

  -r, --release             Release name.

  -s, --source              (Default: release) Source release or repository

  --help                    Display this help screen.

  --version                 Display version information.

Example

Get mts-s-template from the repository

tco --project-name MyNewProject --template-name mts-s-template --source repository --release 0.3.0-preview.2

Important!

Project name must comply with C# identifier rules.It must start with a letter (not number or other characters except for @). For details see here.

Scaffolding from ui program

  1. Go to the releases in this repository here.
  2. Open the latest release.
  3. From Assets Download the latest version of TcOpen.Scaffold.UI.zip, copy it to an empty folder and unzip.
  4. Run TcOpen.Scaffold.UI.exe.

You may get a security warning about the executing file download from the internet. We will provide singed binaries later in the development process. If you have reason to distrust this binary, you can compile your version from the source of this repository.

Available project templates

Template id Description
mts-s-template Standard template for MTS more in the readme of the template templates\mts-s-template
more coming soon -