Tovább a tartalomhoz

Hivatalos sablonok

A Restorm karbantart egy készlet hivatalos sablont, amelyeket közvetlenül a sablonkönyvtárból használhat. Az egyikből kiindulhat, forkolhatja és a saját konvencióihoz igazíthatja.

A sablonkönyvtár: a hivatalos, nemrég használt és egyéni sablonok

A hivatalos sablonok a Monsieur-Dev GitHub szervezet alatt vannak közzétéve:

SablonCélTároló
REST szerver · TypeScriptREST · TypeScript · Expressrestorm-template-server-rest-typescript
REST szerver · .NETREST · C# · ASP.NET Corerestorm-template-server-rest-dotnet
gRPC szerver · TypeScriptgRPC · TypeScriptrestorm-template-server-grpc-typescript
gRPC szerver · .NETgRPC · C# / .NETrestorm-template-server-grpc-dotnet
PostgreSQL adatbázisSQL · PostgreSQLrestorm-template-db-postgres

A távoli sablonokat archívumként töltjük le (soha nem klónozzuk git-tel), biztonsági védőkorlátokkal és korlátozott mérettel.

Az Enterprise előfizetéssel rendelkező szervezetek egy privát sablon- katalógussal rendelkeznek, amely a szervezet tagjai között van megosztva. A könyvtárban a Sablonok <szervezet> lapon jelennek meg, a hivatalosak mellett.

  • Ki adhat hozzá vagy távolíthat el: a szervezet egy adminisztrátora, vagy egy tag, akinek az admin megadta a sablonok kezelése jogot.
  • Hogyan: a könyvtár Sablonok <szervezet> lapjáról (a Hozzáadás gomb — a tároló URL-je és egy leírás), vagy a szervezet adminisztrációs vezérlőpultjából.
  • Mi ez: egy szervezeti sablon egy egyszerű mutató egy git tárolóra (mint egy hivatalos); a szerkezete azonos az alább leírttal, de a láthatósága a szervezet tagjaira korlátozódik.

A Community és Pro kiadások látják a hivatalos sablonokat, és használhatják a saját sablonjaikat (Tároló vagy Helyi mappa) — a kódgenerálás minden kiadásban ingyenes. A megosztott szervezeti sablonok viszont az Enterprise kiadásnak vannak fenntartva.

Egy Restorm sablon egy Cookiecutter/Copier sablon, amelyet egy manifesztummal gazdagítottak:

  • restorm-template.json — a tároló gyökerében (kötelező). Leírja a sablont, és deklarálja a változókat, amelyeket fogyaszt (lásd Generálási változók). Bejelenti a támogatott kontextusverziót is: egy sablon, amely nem deklarál az alkalmazással kompatibilis verziót, elutasításra kerül.
  • copier.yml (vagy copier.yaml) — a Copier konfiguráció, amely nevezetesen deklarálja a generáláskor feltett kérdéseket.
  • A sablon fájljai, .jinja utótaggal, a terv kontextusával renderelve.

Egy egyéni sablon használatához válassza a Tároló forrást (tulajdonos/név a GitHubon) vagy a Helyi mappa forrást (miközben fejleszti) a könyvtárban.