Template ufficiali

Restorm mantiene un insieme di template ufficiali che può utilizzare direttamente dalla libreria di template. Può anche partire da uno di essi, forkarlo e adattarlo alle sue convenzioni.

Il catalogo ufficiale

I template ufficiali sono pubblicati sotto l’organizzazione GitHub Monsieur-Dev:

Template	Destinazione	Repository
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
Base PostgreSQL	SQL · PostgreSQL	restorm-template-db-postgres

I template remoti sono recuperati come un archivio (mai clonati in git), con salvaguardie di sicurezza e una dimensione limitata.

Template di organizzazione (Enterprise)

Le organizzazioni con un abbonamento Enterprise dispongono di un catalogo di template privato, condiviso tra i membri dell’organizzazione. Essi appaiono nella libreria sotto la scheda Template <organizzazione>, accanto agli ufficiali.

• Chi può aggiungerli o rimuoverli: un amministratore dell’ organizzazione, o un membro a cui l’admin ha concesso il diritto gestire i template.
• Come: dalla scheda Template <organizzazione> della libreria (pulsante Aggiungi — l’URL del repository e una descrizione), o dal pannello di amministrazione dell’organizzazione.
• Cos’è: un template di organizzazione è un semplice puntatore a un repository git (come un ufficiale); la sua struttura è identica a quella descritta qui sotto, ma la sua visibilità è ristretta ai membri dell’organizzazione.

Le edizioni Community e Pro vedono i template ufficiali e possono utilizzare i propri template (Repository o Cartella locale) — la generazione di codice è libera su tutte le edizioni. I template di organizzazione condivisi sono, invece, riservati all’edizione Enterprise.

Struttura di un template personalizzato

Un template Restorm è un template Cookiecutter/Copier arricchito di un manifesto:

• restorm-template.json — alla radice del repository (obbligatorio). Descrive il template e dichiara le variabili che consuma (vedi Variabili di generazione). Annuncia anche la versione di contesto che supporta: un template che non dichiara una versione compatibile con l’applicazione è rifiutato.
• copier.yml (o copier.yaml) — la configurazione Copier, che dichiara in particolare le domande poste alla generazione.
• I file del template, con suffisso .jinja, resi con il contesto del design.

Per utilizzare un template personalizzato, scelga la fonte Repository (proprietario/nome su GitHub) o Cartella locale (mentre lo sviluppa) nella libreria.

Note

Vuole proporre un template alla comunità? Le regole di contribuzione dei template ufficiali sono documentate nel repository dell’ applicazione Restorm (docs/contributing).