Getting Started with Twinit Template Development
A Twinit Template may contain a variety of materials such as a package of files used to create a Twinit workspace in a given state, a user interface for interacting with and using a template's workspace, and documentation for the template outlining its deployment, implementation, and usage.
For example templates be sure to refer to the Available Templates section.
Template Documentation#
All templates must be provided with complete documentation describing the templates deployment and migration procedures, implementation details such as data model, and usage.
Template User Interface#
A template user interface would be any type of client that connects to and interacts with Twinit. Often Twinit clients are web clients built with the twinit ipa-core React framework. However, a Twinit client could be a native mobile app, a desktop app, an integrated component within another application, or any other type of client.
A template's user interface should be provided with instructions on how to build, test, and deploy the user interface.
Template Configuration Materials#
The core of the template, however, is the Twinit backend configuration materials. These are the materials that are deployed to a workspace or project on Twinit to create an application.
These could be scripts containing business logic for the client, user configs specifying ipa-core user interface configuration, custom API configurations, Datasource Orchestrators, user groups and permissions, Item Service collections and collection data, and much more.
While the template documentation can include steps to manually deploy the configuration materials to Twinit, a better solution is to create a Template Package.
A Template Package provides a way to define a workspace or project state that can be reliably and repeatedly recreated using a consistent deployment mechanism available in various Twinit tools.
A Template Package contains all the scripts, configs, user group definitions, and more needed to create a deploy the template, along with the definition of how to do so.
The Template Package specification is open to all, so you can use it o create your own Template Packages for your own Twinit Templates.
To learn more about Template Packages and how to create your own see the Understanding Template Packages documentation.