---
title: "Walkthrough: Using the Getting Started template"
slug: "walkthrough--using-the-getting-started-template"
abstract: "How to use the Getting Started template to quickly set up Sitecore containers and a rendering host for your first Sitecore Headless Development experience."
---
# Walkthrough: Using the Getting Started template

Sitecore provides a Getting Started template for Sitecore developers that want to try out [Sitecore Headless Development](https://doc.sitecore.com/xp/en/developers/100/developer-tools/sitecore-headless-development-conceptual-overview.html "Sitecore Headless Development conceptual overview") with [ASP.NET](https://dotnet.microsoft.com/apps/aspnet) and [Sitecore containers](https://doc.sitecore.com/xp/en/developers/100/developer-tools/containers-in-sitecore-development.html "Containers in Sitecore development"). It can be used to get you started quickly or to kickstart new customer projects.

The template does not implement Sitecore Helix conventions for solution architecture. As you begin building your Sitecore solution, we recommend that you review [Sitecore Helix](https://helix.sitecore.net/) and the [Sitecore Helix Examples](https://sitecore.github.io/Helix.Examples/) for guidance on implementing a modular solution architecture.

The template includes:

- A [Docker](https://www.docker.com/) environment for a Sitecore XP0 topology with an ASP.NET rendering host.

    > [!note]
    > The included `docker-compose.yml`file is a stock XP0 environment from the Sitecore Container Support Package. All changes for this solution are included in the `docker-compose.override.yml` file.

- Serialized items for a one-page sample site. See the `src\Items.module.config` file for details.
- An [MSBuild](https://docs.microsoft.com/en-us/visualstudio/msbuild/msbuild) project named `Platform` for deploying configuration and code into the Sitecore Content Management role. See the `src\platform` folder for details.
- An MSBuild project named `RenderingHost` for an ASP.NET rendering host. See the `src\rendering` folder for details.

To create a solution from the Getting Started template, complete the following procedures:

- [Install the prerequisites](https://doc.sitecore.com/xp/en/developers/100/developer-tools/walkthrough--using-the-getting-started-template.html#UUID-f977232d-10af-7cda-da62-6f80c95e1a90_section-idm231883998424798 "Install the prerequisites")
- [Install the template](https://doc.sitecore.com/xp/en/developers/100/developer-tools/walkthrough--using-the-getting-started-template.html#UUID-f977232d-10af-7cda-da62-6f80c95e1a90_section-idm231884037534541 "Install the template")
- [Create the MyProject solution](https://doc.sitecore.com/xp/en/developers/100/developer-tools/walkthrough--using-the-getting-started-template.html#UUID-f977232d-10af-7cda-da62-6f80c95e1a90_section-idm231884002151201 "Create the MyProject solution")
- [Test the MyProject solution](https://doc.sitecore.com/xp/en/developers/100/developer-tools/walkthrough--using-the-getting-started-template.html#UUID-f977232d-10af-7cda-da62-6f80c95e1a90_section-idm231884014512248 "Test the MyProject solution")

## Install the prerequisites

Before you can install the template and create a solution, make sure that you have these software components installed on your workstation:

- [.NET Core 3.1 SDK](https://dotnet.microsoft.com/download/dotnet-core/3.1) (check your installed version with the `dotnet --version` command)
- [.NET Framework 4.8 SDK](https://dotnet.microsoft.com/download/dotnet-framework/net48) (see the [Microsoft procedure for checking .NET Framework versions](https://docs.microsoft.com/en-us/dotnet/framework/migration-guide/how-to-determine-which-versions-are-installed))
- [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/)
- [Docker for Windows](https://docs.docker.com/docker-for-windows/install/) (with Windows Containers enabled)
- [PowerShell 5.1](https://docs.microsoft.com/en-us/skypeforbusiness/set-up-your-computer-for-windows-powershell/download-and-install-windows-powershell-5-1) (PowerShell 7 is not supported)

See the [Sitecore Containers documentation](https://doc.sitecore.com/xp/en/developers/100/developer-tools/set-up-the-environment.html "Set up the environment") for more information on system requirements.

## Install the template

You download and install the template in your file system. Afterward, you can create solutions based on the template.

To install the template:

1. Open PowerShell with administrator privileges.
2. Run the following command:

    ```text
    dotnet new install Sitecore.DevEx.Templates --nuget-source https://nuget.sitecore.com/resources/v3/index.json
    ```

The `dotnet` tool does not provide obvious feedback that the installation was successful. However, the install command ends by listing all of the installed templates. If the install is successful, the list includes `sitecore.aspnet.gettingstarted`.

## Create the MyProject solution

You can name your solution anything you like, but in this example, we name the solution `MyProject`.

To create the `MyProject` solution:

1. Open PowerShell with administrator privileges.
2. Check if you have Internet Information Server running on port 443:

    ```text
    Get-Process -Id (Get-NetTCPConnection -LocalPort 443).OwningProcess
    ```

    If you do, you must to stop it:

    ```text
    iisreset /stop
    ```

3. Check if you have Apache Solr or any other service running on port 8984:

    ```text
    Get-Process -Id (Get-NetTCPConnection -LocalPort 8984).OwningProcess
    ```

    If you do, you must stop it:

    ```text
    Stop-Service -Name "<the name of your service>"
    ```

    Or, if you have started it with Non-Sucking Service Manager, stop it with this command:

    ```text
    nssm stop "<the name of your service>"
    ```

4. Go to your solutions folder and create the `MyProject` solution and project:

    ```text
    dotnet new sitecore.aspnet.gettingstarted -n MyProject
    ```

5. Go to the `MyProject/` folder.
6. You use the provided `init.ps1` script to prepare the following items for the Sitecore container environment:
    - A valid/trusted wildcard certificate for `*.myproject.localhost`.
    - The hosts file entries for `myproject.localhost`.
    - The required environment variable values in the `.env` file for the Sitecore instance.

    > [!important]
    > -   Using non-Latin characters in the project/folder name can give unexpected results because of character limitations in Docker registry names and URLs.
    >
    > -   See the [Sitecore Containers documentation](https://containers.doc.sitecore.com/) for more information on these preparation steps.

    To prepare the Sitecore container environment:

    ```text
    .\init.ps1 -InitEnv -LicenseXmlPath "<C:\path\to\license.xml><path to your license.xml file>" -AdminPassword "<your Sitecore administrator password>"
    ```

    Provide an absolute path for the license file.

    Out of the box, this example doesn't include a reference to the `.env` file in the `.gitignore` file. This is so that developers can share initialized environment variables. If you check your `.env` file into source control, other developers can prepare a certificate and hosts file entries by simply running the `init.ps1` script.

    If your Sitecore solution and/or its data are sensitive, we recommend that you keep the `.env` file excluded from source control and provide another means of centrally configuring the information within.

7. Download the Sitecore Docker images and install the containers:

    ```text
    .\up.ps1
    ```

    The template creates the following entries in the Windows `hosts` file. Each of them points to a Sitecore container:

    - [`https://id.myproject.localhost/`](https://id.myproject.localhost/) points to the `myproject_id_1` container with a Sitecore instance hosting [Sitecore Identity Server](https://doc.sitecore.com/xp/en/developers/100/platform-administration-and-architecture/sitecore-identity-server.html).
    - [`https://cm.myproject.localhost/`](https://cm.myproject.localhost/) points to the `myproject_cm_1` container with a Sitecore instance hosting [Content Management](https://doc.sitecore.com/xp/en/developers/100/platform-administration-and-architecture/content-management--cm-.html), [Content Delivery](https://doc.sitecore.com/xp/en/developers/100/platform-administration-and-architecture/content-delivery--cd-.html), and [Sitecore Layout Service](https://doc.sitecore.com/xp/en/developers/100/developer-tools/sitecore-layout-service.html "Sitecore Layout Service").
    - [`https://www.myproject.localhost/`](https://www.myproject.localhost/) points to the `myproject_rendering_1` container with the [rendering host](https://doc.sitecore.com/xp/en/developers/100/developer-tools/sitecore-headless-development-conceptual-overview.html "Sitecore Headless Development conceptual overview").
8. Wait for the script to open a browser tab for the [Sitecore Identity Server](https://doc.sitecore.com/xp/en/developers/100/platform-administration-and-architecture/sitecore-identity-server.html). Then log in and accept the device authorization.
9. Wait for the script to open browser tabs for Content Management and the rendering host.

## Test the MyProject solution

See [how to publish, run, and test the Getting Started template items and projects](https://doc.sitecore.com/xp/en/developers/100/developer-tools/publish,-run,-and-test-the-getting-started-template-projects.md "Publish, run, and test the Getting Started template projects").

> [!tip]
> Review the `README` files in the projects and the solution for additional information.