Officiële templates

Restorm onderhoudt een set officiële templates die u rechtstreeks kunt gebruiken vanuit de templatebibliotheek. U kunt ook vertrekken van een van hen, het forken en het aanpassen aan uw conventies.

De officiële catalogus

De officiële templates worden gepubliceerd onder de GitHub-organisatie Monsieur-Dev:

Template	Doel	Repository
Server REST · TypeScript	REST · TypeScript · Express	restorm-template-server-rest-typescript
Server REST · .NET	REST · C# · ASP.NET Core	restorm-template-server-rest-dotnet
Server gRPC · TypeScript	gRPC · TypeScript	restorm-template-server-grpc-typescript
Server gRPC · .NET	gRPC · C# / .NET	restorm-template-server-grpc-dotnet
PostgreSQL-database	SQL · PostgreSQL	restorm-template-db-postgres

De externe templates worden opgehaald als een archief (nooit gekloond via git), met veiligheidsvoorzieningen en een begrensde omvang.

Organisatietemplates (Enterprise)

Organisaties met een Enterprise-abonnement beschikken over een privé catalogus van templates, gedeeld tussen de leden van de organisatie. Ze verschijnen in de bibliotheek onder het tabblad Templates <organisatie>, naast de officiële.

• Wie ze kan toevoegen of verwijderen: een beheerder van de organisatie, of een lid aan wie de admin het recht templates beheren heeft verleend.
• Hoe: vanuit het tabblad Templates <organisatie> van de bibliotheek (knop Toevoegen — de repository-URL en een beschrijving), of vanuit het administratie-dashboard van de organisatie.
• Wat het is: een organisatietemplate is een simpele verwijzing naar een git-repository (zoals een officieel); zijn structuur is identiek aan die hieronder beschreven, maar zijn zichtbaarheid is beperkt tot de leden van de organisatie.

De edities Community en Pro zien de officiële templates en kunnen hun eigen templates gebruiken (Repository of Lokale map) — de codegeneratie is gratis op alle edities. De gedeelde organisatietemplates zijn echter voorbehouden aan de edition Enterprise.

Structuur van een aangepast template

Een Restorm-template is een Cookiecutter/Copier-template verrijkt met een manifest:

• restorm-template.json — in de wortel van de repository (verplicht). Het beschrijft het template en declareert de variabelen die het verbruikt (zie Generatievariabelen). Het kondigt ook de contextversie aan die het ondersteunt: een template dat geen met de applicatie compatibele versie declareert, wordt geweigerd.
• copier.yml (of copier.yaml) — de Copier-configuratie, die met name de bij de generatie gestelde vragen declareert.
• De templatebestanden, met achtervoegsel .jinja, gerenderd met de context van het ontwerp.

Om een aangepast template te gebruiken, kiest u in de bibliotheek de bron Repository (eigenaar/naam op GitHub) of Lokale map (terwijl u het ontwikkelt).

Note

Wilt u een template aanbieden aan de community? De bijdrageregels van de officiële templates zijn gedocumenteerd in de repository van de Restorm-applicatie (docs/contributing).