Skip to main content

Templates

Using templates guides users through the process of creating new entities, such as microservices, libraries, and more. Templates help enforce best practices and ensure consistency across projects.

Templates can include various steps to automate the setup of new projects, such as:

  • Fetching base templates or boilerplate code from repositories
  • Generating files and directories with customized content
  • Initializing version control repositories
  • Setting up CI/CD pipelines
  • Registering the new component in the component catalog

Using a Template​

To use a template, click Create via the dashboard sidebar, then select a desired template from the list.

Fill in the required parameters, such as the service name, and initiate the creation process. The developer platform then uses the template to scaffold a new project based on the provided parameters.

Consistency and Best Practices​

By using templates, organizations ensure that new projects adhere to established standards and best practices. Templates encapsulate knowledge about the organization's preferred tools, configurations, and conventions, reducing the learning curve for new developers and increasing overall productivity.

References​

If you'd like to learn more about templates, check out the Backstage Software Templates page.