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
- Your repository name must match the project name e.g.
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
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
- Username:
- 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