Quick Start

Platform CLI (One CLI to rule them all)¶

La interfaz de la línea de comandos (CLI) de Platform es una cadena de herramientas multiplataforma para crear repositorios y proyectos Platform (API/Console).

Instalacion¶

Se debe ejecutar el siguiente commando para instalar la CLI de manera global

github-pkg

dotnet tool install dotnet-platform -g --add-source https://nuget.pkg.github.com/architecture-it/index.json

baget-Aro

dotnet tool install dotnet-platform -g --add-source http://baget.apps.aro.andreani.com.ar/v3/index.json

Una vez instalada, podremos:

Crear un repositorio en github.
Crear un proyecto para Visual Studio.

Actualizacion¶

En caso de tener instalada la herramienta y querer actualizar a la version mas reciente, ejecutaremos el siguiente comando:

github-pkg

dotnet tool update dotnet-platform -g --add-source https://nuget.pkg.github.com/architecture-it/index.json

baget-Aro

dotnet tool update dotnet-platform -g --add-source http://baget.apps.aro.andreani.com.ar/v3/index.json

Si todo se ejecuto correctamente podemos visualizar un mensaje como el siguiente:

La herramienta "dotnet-platform" se actualizó correctamente de la versión "3.1.3" a la versión "3.1.5".

Crear repositorio¶

Ejecute el siguiente comando.

platform create repo

repo

El commano nos pedirá el ingreso del nombre del repositorio, la organizacion, seguido del usuario y PAT (personal access token) de github, para poder crear el mismo.

IMPORTANTE

Github depreco y elimino el uso de password cuando se realiza autenticacion http. De ahora en mas, cuando se solicite passwor, se debe utilizar el PAT, se puede ver como crear uno aqui.

Una vez creado el repositorio, el mismo deberia quedar con los siguientes archivos.

.
├── .config
│   └── dotnet-tools.json
├── .editorconfig
├── .gitignore
├── Jenkinsfile
├── README.md
├── SonarQube.Analysis.xml
├── build.cake
├── build.ps1
└── build.sh

Procederemos a clonarlo y a la creación del proyecto.

Crear un Proyecto Platform¶

Como se menciono anteriormente, existen 2 tipos de aplicaciones, Platform Console y Platform API. Procederemos a crear una aplicación Platform ejecutando el siguiente comando.

platform create project --nuget-source http://baget.apps.aro.andreani.com.ar/v3/index.json

repo

El comando nos pedira una serie de datos, como el nombre del proyecto (.csproj), si el proyecto es del tipo API o Consola, por default siempre creara uno del tipo API y en que carpeta queremos los archivos creados. Una vez creado el proyecto, nos preguntara si queremos crear un archivo de solucion o no. En el caso de crear un archivo de solucion, el proyecto previamente creado sera agregado a la misma.

Api¶

Una vez ejecutado el comando podremos ver una estructura como la siguiente.

.
├── .config
│   └── dotnet-tools.json
├── src
│   └── api
|       ├──Modules
|          └── HomeModule.cs  
│       ├── appsettings.Development.yml
|       ├── appsettings.Production.yml
│       ├── appsettings.yml
│       ├── Program.cs
│       ├── SampleApi.csproj
│       └── Startup.cs
├── .editorconfig
├── .gitignore
├── Jenkinsfile
├── README.md
├── SonarQube.Analysis.xml
├── build.cake
├── build.ps1
├── build.sh
└── SampleApi.sln

Console¶

Una vez ejecutado el comando podremos ver una estructura como la siguiente.

.
├── .config
│   └── dotnet-tools.json
├── src
│   └── service
|       ├── appsettings.Development.yml
|       ├── appsettings.Production.yml
│       ├── appsettings.yml
│       ├── Program.cs
│       ├── SampleConsole.csproj
│       └── Startup.cs
├── .editorconfig
├── .gitignore
├── Jenkinsfile
├── README.md
├── SonarQube.Analysis.xml
├── build.cake
├── build.ps1
├── build.sh
└── SampleConsole.sln