Headless Template

Getting started with the Standalone template.

Setup

• Open a terminal where the new project should be set up.

• Execute the commands below:

# Generate the project
dotnet new uc-headless --name "<ProjectName>"

# Step into the new project folder
cd "ProjectName"

# Up the docker instances for SQL and Elasticsearch
docker compose -f docker/docker-compose.yml up -d

# Run the project
dotnet watch run --project "<ProjectName>"

Once your application runs, you can access the administration interface by requesting /ucommerce.

Template options

Attribute	Example Value	Description	Required
--name	"TestProject"	A name to be used for the scaffolded project.
--elastic-password	"mypassword123"	Replace a default password for the Elasticsearch instance.
--sql-edge-password	"mypassword123"	Replace a default password for the SQL Edge instance.
--stripe	true	Add Stripe payment provider integration.
-h	-	Get a list of all available options. This won't execute the command.

Related Articles

pageHeadless