From c3336a9a48120e416fcdd0aefbc1d6526f3be414 Mon Sep 17 00:00:00 2001 From: Esha Noronha Date: Mon, 12 May 2025 14:19:59 +0200 Subject: [PATCH 1/2] Added an article on how to install the starter kit --- 15/umbraco-cms/SUMMARY.md | 1 + .../tutorials/starter-kit/lessons/README.md | 4 ++ .../lessons/install-the-starter-kit.md | 65 +++++++++++++++++++ 3 files changed, 70 insertions(+) create mode 100644 15/umbraco-cms/tutorials/starter-kit/lessons/install-the-starter-kit.md diff --git a/15/umbraco-cms/SUMMARY.md b/15/umbraco-cms/SUMMARY.md index ff4c56e2919..a7c7cdfcd7f 100644 --- a/15/umbraco-cms/SUMMARY.md +++ b/15/umbraco-cms/SUMMARY.md @@ -453,6 +453,7 @@ * [Creating Custom Database Tables with Entity Framework](tutorials/getting-started-with-entity-framework-core.md) * [The Starter Kit](tutorials/starter-kit/README.md) * [Lessons](tutorials/starter-kit/lessons/README.md) + * [Install the Starter Kit](tutorials/starter-kit/lessons/install-the-starter-kit.md) * [Customize the Starter Kit](tutorials/starter-kit/lessons/1-customize-the-starter-kit.md) * [Add a Blog Post Publication Date](tutorials/starter-kit/lessons/2-add-a-blog-post-publication-date/README.md) * [Add a Blog Post Publication Date](tutorials/starter-kit/lessons/2-add-a-blog-post-publication-date/part-2.md) diff --git a/15/umbraco-cms/tutorials/starter-kit/lessons/README.md b/15/umbraco-cms/tutorials/starter-kit/lessons/README.md index 561facbd19b..960b38ff0ec 100644 --- a/15/umbraco-cms/tutorials/starter-kit/lessons/README.md +++ b/15/umbraco-cms/tutorials/starter-kit/lessons/README.md @@ -1,5 +1,9 @@ # Lessons +## [Install the Starter Kit](install-the-starter-kit.md) + +Covers the steps to install the Starter Kit. + ## [Customise the Starter Kit](1-customize-the-starter-kit.md) Learn how to edit and publish content and customise the theme of the site. diff --git a/15/umbraco-cms/tutorials/starter-kit/lessons/install-the-starter-kit.md b/15/umbraco-cms/tutorials/starter-kit/lessons/install-the-starter-kit.md new file mode 100644 index 00000000000..93e5c6fc1c1 --- /dev/null +++ b/15/umbraco-cms/tutorials/starter-kit/lessons/install-the-starter-kit.md @@ -0,0 +1,65 @@ +# Install the Starter Kit + +Installing the Starter Kit provides a pre-built set of templates, content types, and demo content to explore or kickstart your Umbraco project. + +## Outcome + +You’ll have the Umbraco Starter Kit installed in your local project, ready to explore in the backoffice. This setup adds example content and templates — perfect for learning or quick prototyping. + +## Steps + +You can install the Starter Kit in two ways, depending on your preference: + +* [Option 1: Install via .NET CLI](#option-1-install-via-net-cli) +* [Option 2: Install via Visual Studio](#option-2-install-via-visual-studio) + +### Option 1: Install via .NET CLI + +To install the Starter Kit via the .Net CLI, follow these steps: + +1. Open a terminal in your Umbraco project folder. +2. Run the following command to add the Starter Kit package: + +```bash +dotnet add package Umbraco.TheStarterKit +``` + +3. Build the project: + +```bash +dotnet build +``` + +4. Run the project: + +```bash +dotnet run +``` + +5. Go to `https://localhost:xxxx/` to view the Starter Kit content. + +### Option 2: Install via Visual Studio + +To install the starter Kit via Visual Studio, follow these steps: + +1. Open your Umbraco project in Visual Studio. +2. Go to **Tools** -> **NuGet Package Manager** -> **Manage NuGet Packages for Solution...**. +3. Browse for **Umbraco.TheStarterKit**. +4. Select the appropriate version from the Version drop-down depending on the Umbraco version you are using. +5. Click **Install**. +6. Once the package is installed, open the **.csproj** file to make sure the package reference is added: + +```xml + + + +``` + +## Summary + +You now have a fully functional Umbraco site with demo content, templates, and structure to explore. Use this setup to: + +* Learn how content and templates are structured +* Customize and expand it for your own project + +[Back to Lessons](./) From b26b0f525f50b441e567bd06190911d28cf294ae Mon Sep 17 00:00:00 2001 From: Esha Noronha Date: Wed, 14 May 2025 09:34:13 +0200 Subject: [PATCH 2/2] Incorporated comments --- 15/umbraco-cms/SUMMARY.md | 2 +- .../starter-kit/{lessons => }/install-the-starter-kit.md | 9 +++------ 15/umbraco-cms/tutorials/starter-kit/lessons/README.md | 4 ---- 3 files changed, 4 insertions(+), 11 deletions(-) rename 15/umbraco-cms/tutorials/starter-kit/{lessons => }/install-the-starter-kit.md (82%) diff --git a/15/umbraco-cms/SUMMARY.md b/15/umbraco-cms/SUMMARY.md index a7c7cdfcd7f..32097283d78 100644 --- a/15/umbraco-cms/SUMMARY.md +++ b/15/umbraco-cms/SUMMARY.md @@ -452,8 +452,8 @@ * [Add Microsoft Entra ID authentication (Members)](tutorials/add-microsoft-entra-id-authentication.md) * [Creating Custom Database Tables with Entity Framework](tutorials/getting-started-with-entity-framework-core.md) * [The Starter Kit](tutorials/starter-kit/README.md) + * [Install the Starter Kit](tutorials/starter-kit/install-the-starter-kit.md) * [Lessons](tutorials/starter-kit/lessons/README.md) - * [Install the Starter Kit](tutorials/starter-kit/lessons/install-the-starter-kit.md) * [Customize the Starter Kit](tutorials/starter-kit/lessons/1-customize-the-starter-kit.md) * [Add a Blog Post Publication Date](tutorials/starter-kit/lessons/2-add-a-blog-post-publication-date/README.md) * [Add a Blog Post Publication Date](tutorials/starter-kit/lessons/2-add-a-blog-post-publication-date/part-2.md) diff --git a/15/umbraco-cms/tutorials/starter-kit/lessons/install-the-starter-kit.md b/15/umbraco-cms/tutorials/starter-kit/install-the-starter-kit.md similarity index 82% rename from 15/umbraco-cms/tutorials/starter-kit/lessons/install-the-starter-kit.md rename to 15/umbraco-cms/tutorials/starter-kit/install-the-starter-kit.md index 93e5c6fc1c1..9d27225f58a 100644 --- a/15/umbraco-cms/tutorials/starter-kit/lessons/install-the-starter-kit.md +++ b/15/umbraco-cms/tutorials/starter-kit/install-the-starter-kit.md @@ -4,7 +4,7 @@ Installing the Starter Kit provides a pre-built set of templates, content types, ## Outcome -You’ll have the Umbraco Starter Kit installed in your local project, ready to explore in the backoffice. This setup adds example content and templates — perfect for learning or quick prototyping. +You’ll have the Umbraco Starter Kit installed in your local project, ready to explore in the backoffice. This setup adds example content and templates, perfect for learning or quick prototyping. ## Steps @@ -47,7 +47,7 @@ To install the starter Kit via Visual Studio, follow these steps: 3. Browse for **Umbraco.TheStarterKit**. 4. Select the appropriate version from the Version drop-down depending on the Umbraco version you are using. 5. Click **Install**. -6. Once the package is installed, open the **.csproj** file to make sure the package reference is added: +6. Open the **.csproj** file to make sure the package reference is added: ```xml @@ -57,9 +57,6 @@ To install the starter Kit via Visual Studio, follow these steps: ## Summary -You now have a fully functional Umbraco site with demo content, templates, and structure to explore. Use this setup to: - -* Learn how content and templates are structured -* Customize and expand it for your own project +You now have a fully functional Umbraco site with demo content, templates, and structure to explore. Use this setup as the foundation for the upcoming lessons in this Starter Kit tutorial. [Back to Lessons](./) diff --git a/15/umbraco-cms/tutorials/starter-kit/lessons/README.md b/15/umbraco-cms/tutorials/starter-kit/lessons/README.md index 960b38ff0ec..561facbd19b 100644 --- a/15/umbraco-cms/tutorials/starter-kit/lessons/README.md +++ b/15/umbraco-cms/tutorials/starter-kit/lessons/README.md @@ -1,9 +1,5 @@ # Lessons -## [Install the Starter Kit](install-the-starter-kit.md) - -Covers the steps to install the Starter Kit. - ## [Customise the Starter Kit](1-customize-the-starter-kit.md) Learn how to edit and publish content and customise the theme of the site.