Офіційні шаблони

Restorm підтримує набір офіційних шаблонів, які ви можете використовувати безпосередньо з бібліотеки шаблонів. Ви також можете почати з одного з них, зробити його форк і адаптувати до ваших конвенцій.

Бібліотека шаблонів: офіційні, нещодавно використані та персоналізовані шаблони

Офіційний каталог

Офіційні шаблони опубліковано під організацією GitHub Monsieur-Dev:

Шаблон	Ціль	Репозиторій
Сервер REST · TypeScript	REST · TypeScript · Express	`restorm-template-server-rest-typescript`
Сервер REST · .NET	REST · C# · ASP.NET Core	`restorm-template-server-rest-dotnet`
Сервер gRPC · TypeScript	gRPC · TypeScript	`restorm-template-server-grpc-typescript`
Сервер gRPC · .NET	gRPC · C# / .NET	`restorm-template-server-grpc-dotnet`
База PostgreSQL	SQL · PostgreSQL	`restorm-template-db-postgres`

Віддалені шаблони завантажуються як архів (ніколи не клонуються через git), із запобіжниками безпеки та обмеженням розміру.

Шаблони організації (Enterprise)

Організації з підпискою Enterprise мають приватний каталог шаблонів, спільний між учасниками організації. Вони з’являються в бібліотеці на вкладці Шаблони <організація>, поряд з офіційними.

Хто може додавати чи прибирати: адміністратор організації, або учасник, якому адміністратор надав право керувати шаблонами.
Як: зі вкладки Шаблони <організація> бібліотеки (кнопка Додати — URL репозиторію та опис), або з панелі адміністрування організації.
Що це таке: шаблон організації — це простий вказівник на git-репозиторій (як офіційний); його структура ідентична описаній нижче, але його видимість обмежена учасниками організації.

Видання Community та Pro бачать офіційні шаблони й можуть використовувати власні шаблони (Репозиторій або Локальна тека) — генерація коду безкоштовна в усіх виданнях. Спільні шаблони організації ж зарезервовані для видання Enterprise.

Структура персоналізованого шаблону

Шаблон Restorm — це шаблон Cookiecutter/Copier, збагачений маніфестом:

restorm-template.json — у корені репозиторію (обов’язковий). Він описує шаблон і оголошує змінні, які він споживає (див. Змінні генерації). Він також анонсує версію контексту, яку підтримує: шаблон, що не оголошує версію, сумісну із застосунком, відхиляється.
copier.yml (або copier.yaml) — конфігурація Copier, яка оголошує зокрема питання, що ставляться під час генерації.
Файли шаблону, із суфіксом .jinja, відрендерені з контекстом проєкту.

Щоб використати персоналізований шаблон, виберіть джерело Репозиторій (власник/назва на GitHub) або Локальна тека (поки ви його розробляєте) в бібліотеці.