2 votes

Nikcio.UHeadless

  

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.

 

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


Works on

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

See more under Versioning

 

Setup

Install the package:

dotnet add Nikcio.UHeadless

Find it on Nuget (https://www.nuget.org/packages/Nikcio.UHeadless)


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 nameStatus
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
Nikcio.UHeadless.Cache.InMemory      Researching
Nikcio.UHeadless.Cache.Redis Researching
Nikcio.UHeadless.Cache.TextFiles Researching

*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:

TrackUHeadless version     Supported Umbraco version
LTS v3.x.x v10.x.x
Edge v3.x.x v10.x.x
Current stable        v3.x.x v10.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 😄

Screenshots

NuGet install instructions for Umbraco 9+

dotnet add package Nikcio.UHeadless

Package owner

Nikolaj Brask-Nielsen

Nikolaj Brask-Nielsen

Nikolaj has 168 karma points

Package Compatibility

This package is compatible with the following versions as reported by community members who have downloaded this package:
Untested or doesn't work on Umbraco Cloud
Version 11.0.x (untested)
Version 10.4.x (untested)
Version 10.3.x (untested)
Version 10.2.x (100%)
Version 10.1.x (untested)
Version 10.0.x (untested)
Version 9.5.x (untested)
Version 9.4.x (untested)
Version 9.3.x (untested)
Version 9.2.x (untested)
Version 9.1.x (untested)
Version 9.0.x (untested)
Version 8.18.x (untested)

You must login before you can report on package compatibility.

Previously reported to work on versions:

Package Information

  • Package owner: Nikolaj Brask-Nielsen
  • Created: 25/01/2022
  • Current version 3.0.5
  • License MIT
  • Downloads on Our: 0
  • Downloads on NuGet: 6.2K
  • Total downloads : 6.2K