Siirry sisältöön

Viralliset mallit

Restorm ylläpitää joukkoa virallisia malleja, joita voit käyttää suoraan mallikirjastosta. Voit myös lähteä liikkeelle jostakin niistä, forkata sen ja mukauttaa sen käytäntöihisi.

Mallikirjasto: viralliset, äskettäin käytetyt ja mukautetut mallit

Viralliset mallit on julkaistu GitHub-organisaation Monsieur-Dev alla:

MalliKohdeRepository
REST-palvelin · TypeScriptREST · TypeScript · Expressrestorm-template-server-rest-typescript
REST-palvelin · .NETREST · C# · ASP.NET Corerestorm-template-server-rest-dotnet
gRPC-palvelin · TypeScriptgRPC · TypeScriptrestorm-template-server-grpc-typescript
gRPC-palvelin · .NETgRPC · C# / .NETrestorm-template-server-grpc-dotnet
PostgreSQL-tietokantaSQL · PostgreSQLrestorm-template-db-postgres

Etämallit haetaan arkistona (ei koskaan kloonata gitillä), turvavaroituksin ja rajoitetulla koolla.

Enterprise-tilauksella olevilla organisaatioilla on yksityinen mallikatalogi, joka on jaettu organisaation jäsenten kesken. Ne näkyvät kirjastossa Mallit <organisaatio> -välilehdellä virallisten vieressä.

  • Kuka voi lisätä tai poistaa: organisaation ylläpitäjä, tai jäsen, jolle ylläpitäjä on myöntänyt oikeuden hallita malleja.
  • Miten: kirjaston Mallit <organisaatio> -välilehdeltä (painike Lisää — repositoryn URL ja kuvaus), tai organisaation ylläpitokonsolista.
  • Mitä se on: organisaation malli on yksinkertainen osoitin git-repositoryyn (kuten virallinen); sen rakenne on identtinen alla kuvatun kanssa, mutta sen näkyvyys on rajattu organisaation jäseniin.

Community- ja Pro-versiot näkevät viralliset mallit ja voivat käyttää omia mallejaan (Repository tai Paikallinen kansio) — koodin generointi on ilmaista kaikissa versioissa. Jaetut organisaation mallit on sen sijaan varattu Enterprise-versiolle.

Restorm-malli on Cookiecutter/Copier-malli, jota on rikastettu manifestilla:

  • restorm-template.json — repositoryn juuressa (pakollinen). Se kuvaa mallin ja julistaa muuttujat, joita se kuluttaa (katso Generoinnin muuttujat). Se ilmoittaa myös tukemansa kontekstiversion: malli, joka ei julista sovelluksen kanssa yhteensopivaa versiota, hylätään.
  • copier.yml (tai copier.yaml) — Copier-konfiguraatio, joka julistaa erityisesti generoinnissa esitettävät kysymykset.
  • Mallin tiedostot, joissa on .jinja-pääte, renderöityinä suunnitelman kontekstilla.

Käyttääksesi mukautettua mallia valitse kirjastossa lähteeksi Repository (omistaja/nimi GitHubissa) tai Paikallinen kansio (kun kehität sitä).