Officielle skabeloner

Restorm vedligeholder et sæt officielle skabeloner, som du kan bruge direkte fra skabelonbiblioteket. Du kan også tage udgangspunkt i en af dem, forke den og tilpasse den til dine konventioner.

Det officielle katalog

De officielle skabeloner udgives under GitHub-organisationen Monsieur-Dev:

Skabelon	Mål	Repositorium
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 fjerne skabeloner hentes som et arkiv (aldrig klonet via git), med sikkerhedsforanstaltninger og en begrænset størrelse.

Organisationsskabeloner (Enterprise)

Organisationer på et Enterprise-abonnement råder over et privat katalog af skabeloner, delt mellem organisationens medlemmer. De vises i biblioteket under fanen Skabeloner <organisation>, ved siden af de officielle.

• Hvem der kan tilføje eller fjerne dem: en administrator for organisationen, eller et medlem, som admin har tildelt retten administrer skabeloner.
• Hvordan: fra fanen Skabeloner <organisation> i biblioteket (knappen Tilføj — repositoriets URL og en beskrivelse), eller fra organisationens administrationsdashboard.
• Hvad det er: en organisationsskabelon er en simpel peger til et git-repositorium (som en officiel); dens struktur er identisk med den, der er beskrevet nedenfor, men dens synlighed er begrænset til organisationens medlemmer.

Udgaverne Community og Pro ser de officielle skabeloner og kan bruge deres egne skabeloner (Repositorium eller Lokal mappe) — kodegenereringen er fri i alle udgaver. De delte organisationsskabeloner er derimod forbeholdt udgaven Enterprise.

Strukturen af en tilpasset skabelon

En Restorm-skabelon er en Cookiecutter/Copier-skabelon beriget med et manifest:

• restorm-template.json — i repositoriets rod (obligatorisk). Den beskriver skabelonen og erklærer de variabler, den forbruger (se Genereringsvariabler). Den annoncerer også den kontekstversion, den understøtter: en skabelon, der ikke erklærer en version, der er kompatibel med applikationen, afvises.
• copier.yml (eller copier.yaml) — Copier-konfigurationen, som blandt andet erklærer de spørgsmål, der stilles ved genereringen.
• Skabelonfilerne, med suffikset .jinja, renderet med designets kontekst.

For at bruge en tilpasset skabelon skal du vælge kilden Repositorium (ejer/navn på GitHub) eller Lokal mappe (mens du udvikler den) i biblioteket.

Note

Ønsker du at tilbyde en skabelon til fællesskabet? Bidragsreglerne for de officielle skabeloner er dokumenteret i Restorm-applikationens repositorium (docs/contributing).