Ir al contenido

Plantillas oficiales

Restorm mantiene un conjunto de plantillas oficiales que puede utilizar directamente desde la biblioteca de plantillas. También puede partir de una de ellas, forkearla y adaptarla a sus convenciones.

La biblioteca de plantillas: las plantillas oficiales, recientemente usadas y personalizadas

Las plantillas oficiales se publican bajo la organización GitHub Monsieur-Dev:

PlantillaDestinoRepositorio
Servidor REST · TypeScriptREST · TypeScript · Expressrestorm-template-server-rest-typescript
Servidor REST · .NETREST · C# · ASP.NET Corerestorm-template-server-rest-dotnet
Servidor gRPC · TypeScriptgRPC · TypeScriptrestorm-template-server-grpc-typescript
Servidor gRPC · .NETgRPC · C# / .NETrestorm-template-server-grpc-dotnet
Base PostgreSQLSQL · PostgreSQLrestorm-template-db-postgres

Las plantillas remotas se recuperan como un archivo comprimido (nunca clonadas en git), con salvaguardas de seguridad y un tamaño limitado.

Las organizaciones con una suscripción Enterprise disponen de un catálogo de plantillas privado, compartido entre los miembros de la organización. Aparecen en la biblioteca bajo la pestaña Plantillas <organización>, junto a las oficiales.

  • Quién puede añadirlas o retirarlas: un administrador de la organización, o un miembro a quien el admin haya concedido el derecho gestionar las plantillas.
  • Cómo: desde la pestaña Plantillas <organización> de la biblioteca (botón Añadir — la URL del repositorio y una descripción), o desde el tablero de administración de la organización.
  • Qué es: una plantilla de organización es un simple puntero hacia un repositorio git (como una oficial); su estructura es idéntica a la descrita a continuación, pero su visibilidad está restringida a los miembros de la organización.

Las ediciones Community y Pro ven las plantillas oficiales y pueden utilizar sus propias plantillas (Repositorio o Carpeta local) — la generación de código es libre en todas las ediciones. Las plantillas de organización compartidas están, en cambio, reservadas a la edición Enterprise.

Una plantilla Restorm es una plantilla Cookiecutter/Copier enriquecida con un manifiesto:

  • restorm-template.json — en la raíz del repositorio (obligatorio). Describe la plantilla y declara las variables que consume (véase Variables de generación). Anuncia también la versión de contexto que admite: una plantilla que no declara una versión compatible con la aplicación es rechazada.
  • copier.yml (o copier.yaml) — la configuración Copier, que declara en particular las preguntas planteadas al generar.
  • Los archivos de la plantilla, con sufijo .jinja, renderizados con el contexto del diseño.

Para utilizar una plantilla personalizada, elija la fuente Repositorio (propietario/nombre en GitHub) o Carpeta local (mientras la desarrolla) en la biblioteca.