Szablony oficjalne

Restorm utrzymuje zestaw szablonów oficjalnych, których może Pan/Pani używać bezpośrednio z biblioteki szablonów. Może Pan/Pani również wyjść od jednego z nich, sforkować go i dostosować do własnych konwencji.

Biblioteka szablonów: szablony oficjalne, ostatnio używane i niestandardowe

Oficjalny katalog

Szablony oficjalne są publikowane pod organizacją GitHub Monsieur-Dev:

Szablon	Cel	Repozytorium
Serwer REST · TypeScript	REST · TypeScript · Express	`restorm-template-server-rest-typescript`
Serwer REST · .NET	REST · C# · ASP.NET Core	`restorm-template-server-rest-dotnet`
Serwer gRPC · TypeScript	gRPC · TypeScript	`restorm-template-server-grpc-typescript`
Serwer gRPC · .NET	gRPC · C# / .NET	`restorm-template-server-grpc-dotnet`
Baza PostgreSQL	SQL · PostgreSQL	`restorm-template-db-postgres`

Zdalne szablony są pobierane jako archiwum (nigdy klonowane przez git), z zabezpieczeniami i ograniczonym rozmiarem.

Szablony organizacji (Enterprise)

Organizacje z abonamentem Enterprise dysponują prywatnym katalogiem szablonów, współdzielonym między członkami organizacji. Pojawiają się one w bibliotece pod zakładką Szablony <organizacji>, obok oficjalnych.

Kto może je dodawać lub usuwać: administrator organizacji lub członek, któremu admin przyznał uprawnienie zarządzaj szablonami.
Jak: z zakładki Szablony <organizacji> biblioteki (przycisk Dodaj — URL repozytorium i opis) lub z panelu administracyjnego organizacji.
Czym są: szablon organizacji to zwykły wskaźnik do repozytorium git (jak oficjalny); jego struktura jest identyczna z opisaną poniżej, ale jego widoczność jest ograniczona do członków organizacji.

Edycje Community i Pro widzą szablony oficjalne i mogą używać własnych szablonów (Repozytorium lub Folder lokalny) — generowanie kodu jest darmowe we wszystkich edycjach. Współdzielone szablony organizacji są natomiast zarezerwowane dla edycji Enterprise.

Struktura niestandardowego szablonu

Szablon Restorm to szablon Cookiecutter/Copier wzbogacony o manifest:

restorm-template.json — w katalogu głównym repozytorium (obowiązkowy). Opisuje szablon i deklaruje zmienne, które on konsumuje (zobacz Zmienne generowania). Ogłasza również wersję kontekstu, którą obsługuje: szablon, który nie deklaruje wersji zgodnej z aplikacją, jest odrzucany.
copier.yml (lub copier.yaml) — konfiguracja Copier, która deklaruje w szczególności pytania zadawane podczas generowania.
Pliki szablonu, z sufiksem .jinja, renderowane z kontekstem projektu.

Aby użyć niestandardowego szablonu, proszę wybrać w bibliotece źródło Repozytorium (właściciel/nazwa na GitHub) lub Folder lokalny (podczas gdy go Pan/Pani rozwija).