Templates officiels

Restorm maintient un jeu de templates officiels que vous pouvez utiliser directement depuis la bibliothèque de templates. Vous pouvez aussi partir de l’un d’eux, le forker et l’adapter à vos conventions.

Le catalogue officiel

Les templates officiels sont publiés sous l’organisation GitHub Monsieur-Dev :

Template	Cible	Dépôt
Serveur REST · TypeScript	REST · TypeScript · Express	restorm-template-server-rest-typescript
Serveur REST · .NET	REST · C# · ASP.NET Core	restorm-template-server-rest-dotnet
Serveur gRPC · TypeScript	gRPC · TypeScript	restorm-template-server-grpc-typescript
Serveur gRPC · .NET	gRPC · C# / .NET	restorm-template-server-grpc-dotnet
Base PostgreSQL	SQL · PostgreSQL	restorm-template-db-postgres

Les templates distants sont récupérés comme une archive (jamais clonés en git), avec des garde-fous de sécurité et une taille plafonnée.

Templates d’organisation (Enterprise)

Les organisations sur un abonnement Enterprise disposent d’un catalogue de templates privé, partagé entre les membres de l’organisation. Ils apparaissent dans la bibliothèque sous l’onglet Templates <organisation>, à côté des officiels.

• Qui peut en ajouter ou en retirer : un administrateur de l’organisation, ou un membre à qui l’admin a accordé le droit gérer les templates.
• Comment : depuis l’onglet Templates <organisation> de la bibliothèque (bouton Ajouter — l’URL du dépôt et un descriptif), ou depuis le tableau de bord d’administration de l’organisation.
• Ce que c’est : un template d’organisation est un simple pointeur vers un dépôt git (comme un officiel) ; sa structure est identique à celle décrite ci-dessous, mais sa visibilité est restreinte aux membres de l’organisation.

Les éditions Community et Pro voient les templates officiels et peuvent utiliser leurs propres templates (Dépôt ou Dossier local) — la génération de code est libre sur toutes les éditions. Les templates d’organisation partagés sont, eux, réservés à l’édition Enterprise.

Structure d’un template personnalisé

Un template Restorm est un template Cookiecutter/Copier enrichi d’un manifeste :

• restorm-template.json — à la racine du dépôt (obligatoire). Il décrit le template et déclare les variables qu’il consomme (voir Variables de génération). Il annonce aussi la version de contexte qu’il prend en charge : un template qui ne déclare pas une version compatible avec l’application est refusé.
• copier.yml (ou copier.yaml) — la configuration Copier, qui déclare notamment les questions posées à la génération.
• Les fichiers du template, suffixés en .jinja, rendus avec le contexte du design.

Pour utiliser un template personnalisé, choisissez la source Dépôt (propriétaire/nom sur GitHub) ou Dossier local (pendant que vous le développez) dans la bibliothèque.

Note

Vous souhaitez proposer un template à la communauté ? Les règles de contribution des templates officiels sont documentées dans le dépôt de l’application Restorm (docs/contributing).