Offisielle maler

Restorm vedlikeholder et sett med offisielle maler som du kan bruke direkte fra malbiblioteket. Du kan også ta utgangspunkt i en av dem, forke den og tilpasse den til konvensjonene dine.

Det offisielle katalogen

De offisielle malene publiseres under GitHub-organisasjonen Monsieur-Dev:

Mal	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 eksterne malene hentes som et arkiv (aldri klonet via git), med sikkerhetsvern og en begrenset størrelse.

Organisasjonsmaler (Enterprise)

Organisasjoner på et Enterprise-abonnement har et privat katalog med maler, delt mellom organisasjonens medlemmer. De vises i biblioteket under fanen Maler <organisasjon>, ved siden av de offisielle.

• Hvem som kan legge dem til eller fjerne dem: en administrator for organisasjonen, eller et medlem som admin har gitt retten administrer maler.
• Hvordan: fra fanen Maler <organisasjon> i biblioteket (knappen Legg til — repositoriets URL og en beskrivelse), eller fra organisasjonens administrasjonsdashbord.
• Hva det er: en organisasjonsmal er en enkel peker til et git-repositorium (som en offisiell); strukturen dens er identisk med den som er beskrevet nedenfor, men synligheten dens er begrenset til organisasjonens medlemmer.

Utgavene Community og Pro ser de offisielle malene og kan bruke sine egne maler (Repositorium eller Lokal mappe) — kodegenereringen er gratis i alle utgaver. De delte organisasjonsmalene er derimot forbeholdt utgaven Enterprise.

Strukturen til en tilpasset mal

En Restorm-mal er en Cookiecutter/Copier-mal beriket med et manifest:

• restorm-template.json — i roten av repositoriet (obligatorisk). Den beskriver malen og erklærer de variablene den forbruker (se Genereringsvariabler). Den kunngjør også den kontekstversjonen den støtter: en mal som ikke erklærer en versjon som er kompatibel med applikasjonen, avvises.
• copier.yml (eller copier.yaml) — Copier-konfigurasjonen, som blant annet erklærer de spørsmålene som stilles ved genereringen.
• Malfilene, med suffikset .jinja, rendret med konteksten til designet.

For å bruke en tilpasset mal velger du kilden Repositorium (eier/navn på GitHub) eller Lokal mappe (mens du utvikler den) i biblioteket.

Note

Ønsker du å tilby en mal til fellesskapet? Bidragsreglene for de offisielle malene er dokumentert i repositoriet til Restorm-applikasjonen (docs/contributing).