Nikcio.UHeadless 3.3.0

.NET 6.0
dotnet add package Nikcio.UHeadless --version 3.3.0
NuGet\Install-Package Nikcio.UHeadless -Version 3.3.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Nikcio.UHeadless" Version="3.3.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Nikcio.UHeadless --version 3.3.0
#r "nuget: Nikcio.UHeadless, 3.3.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Nikcio.UHeadless as a Cake Addin
#addin nuget:?package=Nikcio.UHeadless&version=3.3.0

// Install Nikcio.UHeadless as a Cake Tool
#tool nuget:?package=Nikcio.UHeadless&version=3.3.0

Nikcio.UHeadless

Maintainability Build UHeadless Nuget Downloads Nuget Version Nuget (with prereleases)

😄 If you use and like Nikcio.UHeadless please consider becoming a GitHub Sponsor 😄

This repository creates an easy setup solution for making Umbraco headless. It comes with a wide range of extensibility options that can be tailored to your needs.

Works on

  • Umbraco 9 (v1.x.x & v2.x.x)
  • Umbraco 10 (v2.x.x & v3.x.x)
  • Umbraco 11 (v3.x.x)

See more under Versioning

Setup

Install the package:

dotnet add Nikcio.UHeadless

Find it on Nuget

Add the extensions to the Startup.cs file:

using Nikcio.UHeadless.Extensions;

public void ConfigureServices(IServiceCollection services)
        {
            services.AddUmbraco(_env, _config)
                /* Code obmitted for clarity */
                .AddUHeadless()
                /* Code obmitted for clarity */
        }

public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
    /* Code obmitted for clarity */

    app.UseUHeadlessGraphQLEndpoint();

    app.UseUmbraco()
    /* etc... */
}

Now your content will be avalible at /graphql

To get started try adding some content to the root and run the following query:

{
  contentAtRoot {
    nodes {
      id,
      name
    }
  }
}

Documentation

Find the docs here

Extending packages

See How to use a extending package

Package name Status
Nikcio.UHeadless.Content Included*
Nikcio.UHeadless.Media Included*
Nikcio.UHeadless.ContentTypes Included*
Nikcio.UHeadless.Members Available
Nikcio.UHeadless.DataTypes Not started
Nikcio.UHeadless.Dictionary Not started
Nikcio.UHeadless.MediaTypes Not started
Nikcio.UHeadless.MemberTypes Not started

*Included means that the package is included in the Nikcio.UHeadless Nuget package.

**Preview means that the package is ready in a preview version.

Note: If a Nikcio.UHeadless.* package is not found in the list above it's not ready for use or is a core/base package used in the packages above.

Versioning

UHeadless following to the best of abillity Semantic Versioning. This means that the version numbers have the following meaning

vX.Y.Z

  • X (Major - Breaking change)
  • Y (Minor - Feature change)
  • Z (Patch - Bug fixes)

This also means that versions doesn't follow Umbracos major versions. To avoid supporting to many major versions the following versioning tactic has been choosen.

Versioning tactic

Each Umbraco LTS version will have a accompanying LTS UHeadless version. All other UHeadless majors not marked as LTS will stop support when a new major is released. In this way you as a developer can choose how often you expect to be updating UHeadless and Umbraco.

The two versioning tracks can be found in the table here:

Track UHeadless version Supported Umbraco version
LTS v3.x.x v10.x.x & v11.x.x
Edge v3.x.x v10.x.x & v11.x.x
Current stable v3.x.x v10.x.x & v11.x.x

Do note that LTS versions will not actively get new featues but will be bugfixed when a newer major is present

Contributing

This package is very much open for contribution see the Contributing Guide


😄 If you use and like Nikcio.UHeadless please consider becoming a GitHub Sponsor 😄

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
3.3.0 79 1/18/2023
3.2.0 554 11/22/2022
3.1.0 150 11/16/2022
3.0.6 277 11/3/2022
3.0.5 290 10/18/2022
3.0.4 494 10/5/2022
3.0.3 193 10/5/2022
3.0.2 239 9/19/2022
3.0.1 250 9/3/2022
3.0.0 446 8/3/2022
3.0.0-preview003 66 8/3/2022
3.0.0-preview002 77 7/16/2022
3.0.0-preview001 69 7/16/2022
2.3.0 371 7/6/2022
2.2.1 323 6/19/2022
2.2.0 503 6/6/2022
2.1.1 312 5/22/2022
2.1.0 356 5/10/2022
2.0.2 310 5/9/2022
2.0.1 299 5/4/2022
2.0.0 340 5/1/2022
2.0.0-preview.3 67 4/26/2022
2.0.0-preview.2 59 4/26/2022
2.0.0-preview.1 89 4/24/2022
2.0.0-preview.0 67 4/14/2022
1.3.0 435 3/5/2022
1.2.0 360 3/1/2022
1.1.0 345 2/26/2022
1.0.0 421 2/6/2022
0.1.7-beta 74 2/5/2022
0.1.6-beta 82 2/5/2022
0.1.5-beta 83 2/4/2022
0.1.4-beta 83 1/27/2022
0.1.3-beta 80 1/27/2022
0.1.2-alpha 80 1/25/2022