Offizielle Templates

Restorm pflegt einen Satz von offiziellen Templates, die Sie direkt aus der Template-Bibliothek verwenden können. Sie können auch von einem von ihnen ausgehen, es forken und es an Ihre Konventionen anpassen.

Der offizielle Katalog

Die offiziellen Templates werden unter der GitHub-Organisation Monsieur-Dev veröffentlicht:

Template	Ziel	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
Datenbank PostgreSQL	SQL · PostgreSQL	restorm-template-db-postgres

Die entfernten Templates werden als Archiv abgerufen (niemals per git geklont), mit Sicherheitsvorkehrungen und einer gedeckelten Größe.

Organisations-Templates (Enterprise)

Organisationen mit einem Enterprise-Abonnement verfügen über einen privaten Katalog von Templates, geteilt zwischen den Mitgliedern der Organisation. Sie erscheinen in der Bibliothek unter dem Tab Templates <Organisation>, neben den offiziellen.

• Wer sie hinzufügen oder entfernen kann: ein Administrator der Organisation oder ein Mitglied, dem der Admin das Recht Templates verwalten gewährt hat.
• Wie: über den Tab Templates <Organisation> der Bibliothek (Schaltfläche Hinzufügen — die Repository-URL und eine Beschreibung) oder über das Administrations-Dashboard der Organisation.
• Was es ist: ein Organisations-Template ist ein einfacher Zeiger auf ein git-Repository (wie ein offizielles); seine Struktur ist identisch mit der unten beschriebenen, aber seine Sichtbarkeit ist auf die Mitglieder der Organisation beschränkt.

Die Editionen Community und Pro sehen die offiziellen Templates und können ihre eigenen Templates verwenden (Repository oder Lokaler Ordner) — die Codegenerierung ist in allen Editionen frei. Die geteilten Organisations-Templates sind jedoch der Edition Enterprise vorbehalten.

Struktur eines benutzerdefinierten Templates

Ein Restorm-Template ist ein Cookiecutter/Copier-Template, angereichert mit einem Manifest:

• restorm-template.json — im Stammverzeichnis des Repositorys (obligatorisch). Es beschreibt das Template und deklariert die Variablen, die es verbraucht (siehe Generierungsvariablen). Es kündigt auch die Kontextversion an, die es unterstützt: ein Template, das keine mit der Anwendung kompatible Version deklariert, wird abgelehnt.
• copier.yml (oder copier.yaml) — die Copier-Konfiguration, die insbesondere die bei der Generierung gestellten Fragen deklariert.
• Die Template-Dateien, mit .jinja suffigiert, gerendert mit dem Kontext des Designs.

Um ein benutzerdefiniertes Template zu verwenden, wählen Sie in der Bibliothek die Quelle Repository (besitzer/name auf GitHub) oder Lokaler Ordner (während Sie es entwickeln).

Note

Sie möchten der Community ein Template anbieten? Die Beitragsregeln der offiziellen Templates sind im Repository der Restorm-Anwendung dokumentiert (docs/contributing).