Officiella mallar

Restorm underhåller en uppsättning officiella mallar som du kan använda direkt från mallbiblioteket. Du kan också utgå från en av dem, forka den och anpassa den till dina konventioner.

Den officiella katalogen

De officiella mallarna publiceras under GitHub-organisationen Monsieur-Dev:

Mall	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-databas	SQL · PostgreSQL	restorm-template-db-postgres

De fjärranslutna mallarna hämtas som ett arkiv (aldrig klonade via git), med säkerhetsspärrar och en begränsad storlek.

Organisationsmallar (Enterprise)

Organisationer på en Enterprise-prenumeration förfogar över en privat katalog av mallar, delad mellan organisationens medlemmar. De visas i biblioteket under fliken Mallar <organisation>, bredvid de officiella.

• Vem som kan lägga till eller ta bort dem: en administratör för organisationen, eller en medlem som admin har beviljat rätten hantera mallar.
• Hur: från fliken Mallar <organisation> i biblioteket (knappen Lägg till — repositoriets URL och en beskrivning), eller från organisationens administrationspanel.
• Vad det är: en organisationsmall är en enkel pekare till ett git-repositorium (som en officiell); dess struktur är identisk med den som beskrivs nedan, men dess synlighet är begränsad till organisationens medlemmar.

Editionerna Community och Pro ser de officiella mallarna och kan använda sina egna mallar (Repositorium eller Lokal mapp) — kodgenereringen är fri i alla editioner. De delade organisationsmallarna är däremot förbehållna editionen Enterprise.

Strukturen hos en anpassad mall

En Restorm-mall är en Cookiecutter/Copier-mall berikad med ett manifest:

• restorm-template.json — i repositoriets rot (obligatorisk). Den beskriver mallen och deklarerar de variabler som den konsumerar (se Genereringsvariabler). Den tillkännager också den kontextversion som den stödjer: en mall som inte deklarerar en version som är kompatibel med applikationen avvisas.
• copier.yml (eller copier.yaml) — Copier-konfigurationen, som bland annat deklarerar de frågor som ställs vid genereringen.
• Mallfilerna, med suffixet .jinja, renderade med designens kontext.

För att använda en anpassad mall, välj källan Repositorium (ägare/namn på GitHub) eller Lokal mapp (medan du utvecklar den) i biblioteket.

Note

Vill du erbjuda en mall till gemenskapen? Bidragsreglerna för de officiella mallarna är dokumenterade i Restorm-applikationens repositorium (docs/contributing).