Přeskočit na obsah

Oficiální šablony

Restorm udržuje sadu oficiálních šablon, které můžete používat přímo z knihovny šablon. Můžete také vyjít z jedné z nich, forknout ji a přizpůsobit svým konvencím.

Knihovna šablon: oficiální, nedávno použité a vlastní šablony

Oficiální šablony jsou publikovány pod GitHub organizací Monsieur-Dev:

ŠablonaCílRepozitář
Server REST · TypeScriptREST · TypeScript · Expressrestorm-template-server-rest-typescript
Server REST · .NETREST · C# · ASP.NET Corerestorm-template-server-rest-dotnet
Server gRPC · TypeScriptgRPC · TypeScriptrestorm-template-server-grpc-typescript
Server gRPC · .NETgRPC · C# / .NETrestorm-template-server-grpc-dotnet
Databáze PostgreSQLSQL · PostgreSQLrestorm-template-db-postgres

Vzdálené šablony jsou získávány jako archiv (nikdy klonovány přes git), s bezpečnostními pojistkami a omezenou velikostí.

Organizace s předplatným Enterprise disponují soukromým katalogem šablon, sdíleným mezi členy organizace. Objevují se v knihovně pod záložkou Šablony <organizace>, vedle oficiálních.

  • Kdo je může přidávat nebo odebírat: administrátor organizace nebo člen, kterému admin udělil oprávnění spravovat šablony.
  • Jak: ze záložky Šablony <organizace> knihovny (tlačítko Přidat — URL repozitáře a popis) nebo z administrátorského panelu organizace.
  • Co to je: šablona organizace je prostý ukazatel na git repozitář (jako oficiální); její struktura je totožná s tou popsanou níže, ale její viditelnost je omezena na členy organizace.

Edice Community a Pro vidí oficiální šablony a mohou používat vlastní šablony (Repozitář nebo Lokální složka) — generování kódu je zdarma ve všech edicích. Sdílené šablony organizace jsou naopak vyhrazeny edici Enterprise.

Šablona Restorm je šablona Cookiecutter/Copier obohacená o manifest:

  • restorm-template.json — v kořeni repozitáře (povinný). Popisuje šablonu a deklaruje proměnné, které konzumuje (viz Proměnné generování). Rovněž oznamuje verzi kontextu, kterou podporuje: šablona, která nedeklaruje verzi kompatibilní s aplikací, je odmítnuta.
  • copier.yml (nebo copier.yaml) — konfigurace Copier, která deklaruje zejména otázky kladené při generování.
  • Soubory šablony, se sufixem .jinja, vykreslené s kontextem návrhu.

Chcete-li použít vlastní šablonu, zvolte v knihovně zdroj Repozitář (vlastník/název na GitHubu) nebo Lokální složka (během jejího vývoje).