Clean 5.2.2

Clean Starter Kit for Umbraco 13 and 15

version 4.1.0 is for Umbraco 13 (Long Term Support)

version 5.0.0 is for Umbraco 15 (Standard Term Support)

If you want the older versions you need to go to the ones lower than version 4.0.0

Latest Release Details:

• Now works on Umbraco 15 with dotnet 9
• You can now use the dotnet new template to install Clean Starter Kit with the Source Code rather than as a package

To try it out on Windows, Mac or Linux, make sure you have downloaded the latest .Net 9 SDK and then run this block of commands in a folder somewhere.

Install it using the dotnet template

# Ensure we have the latest Clean Starter Kit Template installed
dotnet new install Umbraco.Community.Templates.Clean --force

dotnet new umbraco-starter-clean -n MyProject

Install it as a Package

Install on Umbraco 15

# Ensure we have the latest Umbraco templates
dotnet new install Umbraco.Templates::15.0.0 --force

# Create solution/project
dotnet new sln --name "MySolution"
dotnet new umbraco --force -n "MyProject" --friendly-name "Administrator" --email "admin@example.com" --password "1234567890" --development-database-type SQLite
dotnet sln add "MyProject"

#Add starter kit
dotnet add "MyProject" package Clean --version 5.0.0

#Add Packages
#Ignored Clean as it was added as a starter kit

dotnet run --project "MyProject"

Install on Umbraco 13

# Ensure we have the version specific Umbraco templates
dotnet new install Umbraco.Templates::13.5.2 --force

# Create solution/project
dotnet new sln --name "MySolution"
dotnet new umbraco --force -n "MyProject" --friendly-name "Administrator" --email "admin@example.com" --password "1234567890" --development-database-type SQLite
dotnet sln add "MyProject"

#Add starter kit
dotnet add "MyProject" package clean -version 4.1.0

dotnet run --project "MyProject"
#Running

Headless Implementation

Phil Whittaker has created a headless version of this starter kit available at Clean Starter Kit Headless

To set this up you will need to create an umbraco instance of the site as above

Then turn on the content delivery API with the following change to the Umbraco property of the appsettings.json file

      "DeliveryApi": {
        "Enabled": true
      }

Finally to enable revalidation of content you will need to update the Enabled property as below (enmabled is currently set to false).

  "NextJs": {
    "Revalidate": {
      "Enabled": true,
      "WebHookUrls": "[\"http://localhost:3000/api/revalidate\"]",
      "WebHookSecret": "SOMETHING_SECRET"
    }
  }

This presumes that your healdess implementation will be loated at localhost:3000

New API endpoint

We have added a new suite af API endpoints for bespoke functionality within the starter kit

• Dictionary - access to the dictionary items
• Search - the search form
• Contact - the contact form submission

We have added an OpenAPI instance available at /umbraco/swagger/index.html?urls.primaryName=Clean%20starter%20kit