> ## Documentation Index
> Fetch the complete documentation index at: https://backstage.spotify.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Getting Started with Scaffolder
> Create your first Software Template in Portal using premade templates or from scratch, then preview and run it with dry-run mode.
This guide will help you create and run your first Software Templates using the Portal Scaffolder.
## Creating Your First Template
The Portal Scaffolder allows you to create templates directly in the UI without leaving Portal.
### Choose Your Starting Point
When creating a new template, you have two options:
1. **Create from a Premade Template**: Start with an existing template as a base
2. **Create from Scratch**: Build a template from the ground up
### Creating from a Premade Template
1. **Navigate to Create Template**: Click the create new template button
2. **Select Source**: Choose to create from a premade template
1. **Save the template**: Click on the save button
1. **Preview the Template**: Review the template structure and configuration
### Editing Your Template
Once you have a template loaded, you can customize it using the Portal editor:
#### Configure Form Fields
1. Navigate to the form fields configuration section
2. View existing field configurations
3. Add new fields by clicking **Append**
4. Configure field properties:
* Field type
* Label and description
* Validation rules
* Default values
#### Add Actions
Actions define what the template does when executed.
1. Navigate to the actions section
2. Click to add a new action
3. Choose from available actions (e.g., `catalog:register`, `github:create`)
4. Configure action parameters
#### Use Extensions
Extensions provide additional functionality through data filters, functions, and custom values:
1. Navigate to the extensions section
2. Add filters to transform data
3. Define custom functions
4. Set up reusable values
### Testing Your Template
Before publishing, test your template using the **Dry Run** feature:
1. Click **Dry Run** in the template editor
2. Fill in test values in the form
3. Click **Test** to simulate execution without creating resources
4. Review the output to verify expected behavior
5. The dry run shows what repository and resources would be created
### Saving and Publishing
#### Save as Draft
* Click **Save** to save your changes as a draft
* Or click **Download** to download the template locally
* Draft templates can be edited further before publishing
#### Publish Template
1. When ready to make your template available, click **Publish**
2. The template will now appear in the templates list
3. Other users can now discover and run your template
## Running Your First Template
Once you have published templates available, running them is straightforward.
1. **Navigate to Templates**: Go to the Scaffolder templates page in Portal
2. **Select a Template**: Browse available templates and click **Run** on the template you want to use
3. **Fill in Details**:
* Select your organization from the dropdown
* Enter the required information (e.g., repository name, description)
* Review any additional configuration options
4. **Review & Submit**:
* Click **Review** to verify your inputs
* Click **Submit** to execute the template
5. **Monitor Progress**:
* View real-time logs as the template executes
* Check the output section for created resources
* Once complete, you'll see confirmation of the created resources (e.g., repository, catalog entities)
## Next Steps
* Learn more about [template configuration and advanced features](./how-to-guides.mdx)
* Explore the [technical reference and FAQ](./reference.mdx)