Simple

Get quickly set up with everything you need to start developing an Umbraco package.

Front End

Includes an optional front end using Umbraco UI. Configured to work out of the box!

Opinionated

A lot of decisions have been made for you, taking the hassle out of package development.

Readme

jcdcdev.Umbraco.PackageTemplate

An opinionated template for creating Umbraco packages hosted on Github.

Quick Start

Prerequisites

A basic understanding of NuGet package development
- A NuGet API key - Create an API key
A git repository on GitHub
- Your repository name must match the project name e.g. Demo.Package
- GitHub Action Secret - NUGET_API_KEY with your NuGet API key

Install template

dotnet new install jcdcdev.Umbraco.PackageTemplate

Create package

Create new project

dotnet CLI
```
dotnet new jcdcdev-umb-package -o Demo.Package --ghUsername jcdcdev --title "My Demo Package" --description "An empty Umbraco package" --addClient    
```
Visual Studio
- Open Visual Studio
- Create a new project
- Search for jcdcdev-umb-package
- Click Next
- Fill in the project title, description, and other details
- Click Create
Open project in your IDE
Build and run project
Congratulations! You have created an empty Umbraco package 🎉

Now you can implement your package features.

Update README.md with your package details
Update umbraco-marketplace.json with your package details

Publish

Push your code to GitHub
Create a pull request into the main branch
Merge the pull request
A new release will be created

Template Parameters

Documentation

Test Sites

The solution includes a test site for testing your package features against the following Umbraco versions:

10.4.0
12.0.0
13.0.0

Your package project is automatically referenced in each test site.

Running Locally

On first boot each test site will:

Create a SQLite database
Create an admin user
- Username: [email protected]
- Password: 1234567890
Run a uSync import to add starter content

Need help?

Contributing

Contributions to this package are most welcome! Please read the Contributing Guidelines.

Acknowledgments (thanks!)

LottePitcher - opinionated-package-starter

Releases

Umbraco 15

Umbraco 15 is supported until 14/11/2025

4 days ago

| View release

15.0.6

Latest Version

Release Notes

Changes in 15.0.6

🐞 fix: upgrade @hey-api/openapi-ts from 0.61.2 to 0.62.3 0cd7b3a @snyk-bot
🐞 fix: upgrade vite from 5.4.12 to 5.4.14 b104130 @snyk-bot

9 days ago

| View release

15.0.5

Release Notes

Changes in 15.0.5

🐞 fix: upgrade @hey-api/openapi-ts from 0.55.3 to 0.61.2 a585b95 @snyk-bot

15 days ago

| View release

15.0.4

Release Notes

Changes in 15.0.4

🐞 fix: upgrade typescript from 5.6.3 to 5.7.3 253d88a @snyk-bot

25 days ago

| View release

15.0.3

Release Notes

Changes in 15.0.3

🐞 fix: src/templates/UmbracoPackageTemplate/src/UmbracoPackageTemplate.Client/package.json & src/templates/UmbracoPackageTemplate/src/UmbracoPackageTemplate.Client/package-lock.json to reduce vulnerabilities f7b52bb @snyk-bot

one month ago

| View release

15.0.2

Release Notes

Changes in 15.0.2

📖 - 📖 docs: add SECURITY.md 6da28a3

3 months ago

| View release

15.0.1

Release Notes

Changes in 15.0.1

🧹 chore: update jcdcdev.Umbraco.Core to 15.0.0-alpha0007 87eac5c
🧹 chore: update front end dependencies 9e47469
🌟 feature: Umbraco v15 support 8070b17
🧹 chore: update front end dependencies bc2df62

4 months ago

| View release

15.0.0

Release Notes

Changes in 15.0.0

🌟 feature: Umbraco 15 support 3a692ce
🐞 fix: build issue 9b43bf2

Umbraco 14

Umbraco 14 is supported until 30/05/2025

12 days ago

| View release

14.0.2

Latest Version

Release Notes

Changes in 14.0.2

🐞 fix: upgrade typescript from 5.6.3 to 5.7.3 4381256 @snyk-bot

25 days ago

| View release

14.0.1

Release Notes

Changes in 14.0.1

🐞 fix: src/templates/UmbracoPackageTemplate/src/UmbracoPackageTemplate.TestSite/UmbracoPackageTemplate.TestSite.csproj to reduce vulnerabilities 297fd2b @snyk-bot
🐞 fix: src/templates/UmbracoPackageTemplate/src/UmbracoPackageTemplate.Client/package.json & src/templates/UmbracoPackageTemplate/src/UmbracoPackageTemplate.Client/package-lock.json to reduce vulnerabilities a40c901 @snyk-bot

4 months ago

| View release

14.0.0

Release Notes

Changes in 14.0.0

🌟 feature: Umbraco 14 support 026b130
🐝 refactor: clean up test site 960839e
🐞 fix: v14 build 4226ef6

Umbraco 13

Umbraco 13 is supported until 14/12/2026

9 days ago

| View release

13.0.2

Latest Version

Release Notes

Changes in 13.0.2

🐞 fix: upgrade vite from 6.0.0 to 6.0.11 ca27383 @snyk-bot

14 days ago

| View release

13.0.1

Release Notes

Changes in 13.0.1

🐞 fix: upgrade lit from 3.1.2 to 3.2.1 b70de7a @snyk-bot
🐞 fix: src/templates/UmbracoPackageTemplate/src/UmbracoPackageTemplate.Client/package.json & src/templates/UmbracoPackageTemplate/src/UmbracoPackageTemplate.Client/package-lock.json to reduce vulnerabilities f90bd98 @snyk-bot
🐞 fix: src/templates/UmbracoPackageTemplate/src/UmbracoPackageTemplate.TestSite/UmbracoPackageTemplate.TestSite.csproj to reduce vulnerabilities 1ac1d83 @snyk-bot
🐞 fix: upgrade @umbraco-ui/uui from 1.7.2 to 1.12.2 ce51fb8 @snyk-bot

4 months ago

| View release

13.0.0

Release Notes

Changes in 13.0.0

🌟 feature: improved github actions 1e45024
🐝 refactor: remove Umbraco 10 & 12 support d931440
🐝 refactor: clean up test site b3588c3

Unsupported Versions

Version 0.X.X

11 months ago

| View release

0.2.1

Release Notes

Compare 0.2.0...0.2.1

🌟 feature: improve/automate test site set up 57f4116
💢 ci: template validation build pipeline 08cb393
💢 ci: slow cheetah version transforms 9a64ffb
🌟 feature: vs template support 9d9436e
📖 doc: improve README & screenshots a2ecd68

11 months ago

| View release

0.2.0

Release Notes

Compare 0.1.2...0.2.0

🧹 chore: rm v11 test site 115da5c
📖 doc: improve README b979cb5
🌟 feature: add-client param 32ff33a
🌟 feature: improve test sites 95da726
🌟 feature: dependabot 0ce9c0a

one year ago

| View release

0.1.2

Release Notes

Compare 0.1.1...0.1.2

🐞 fix: github actions 9b6b680
🐞 fix: template csproj 561612d

one year ago

| View release

0.1.1

Release Notes

Compare 0.1.0...0.1.1

🐞 fix: add umbraco-marketplace nuget tag (for marketplace support) f55d7cd

one year ago

| View release

0.1.0

Release Notes

Compare 0.0.0...0.1.0

Simple

Front End

Opinionated

Readme

jcdcdev.Umbraco.PackageTemplate

Quick Start

Prerequisites

Create package

dotnet CLI

Visual Studio

Publish

Template Parameters

Test Sites

Running Locally

Need help?

Contributing

Acknowledgments (thanks!)

Releases

Umbraco 15

15.0.6

Release Notes

Changes in 15.0.6

15.0.6-alpha0005

Release Notes

Changes in 15.0.6-alpha0005

15.0.6-alpha0003

Release Notes

Changes in 15.0.6-alpha0003

15.0.5

Release Notes

Changes in 15.0.5

15.0.5-alpha0004

Release Notes

Changes in 15.0.5-alpha0004

15.0.4

Release Notes

Changes in 15.0.4

15.0.4-alpha0003

Release Notes

Changes in 15.0.4-alpha0003

15.0.3

Release Notes

Changes in 15.0.3

15.0.3-alpha0003

Release Notes

Changes in 15.0.3-alpha0003

15.0.2

Release Notes

Changes in 15.0.2

15.0.1

Release Notes

Changes in 15.0.1

15.0.1-alpha0006

Release Notes

Changes in 15.0.1-alpha0006

15.0.0

Release Notes

Changes in 15.0.0

15.0.0-alpha0003

Release Notes

Changes in 15.0.0-alpha0003

Umbraco 14

14.0.2

Release Notes

Changes in 14.0.2

14.0.2-alpha0003

Release Notes

Changes in 14.0.2-alpha0003

14.0.1

Release Notes

Changes in 14.0.1

14.0.1-alpha0011

Release Notes

Changes in 14.0.1-alpha0011

14.0.0

Release Notes

Changes in 14.0.0

Umbraco 13

13.0.2

Release Notes