Nikcio.UHeadless.Base 4.0.0-preview001

Nikcio.UHeadless

Welcome to Nikcio.UHeadless, a powerful package that enables you to create a headless GraphQL interface for your Umbraco CMS. This package provides an easy to setup solution for exposing your data and offers a wide range of extensibility options to tailor the headless functionality to your specific needs.

Compatibility

The Nikcio.UHeadless package is compatible with the following Umbraco versions:

For more information, please refer to the Versioning section.

Setup

Installation

To install the Nikcio.UHeadless package, run the following command:

dotnet add Nikcio.UHeadless

You can also find the package on NuGet.

Integration

To integrate the package into your project, follow these steps:

1. Open your Startup.cs file.

2. Add the following using statement:

   using Nikcio.UHeadless.Extensions;
   

3. In the ConfigureServices method, add the following code:

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

4. In the Configure method, add the following code:

   public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
   {
       /* Code omitted for clarity */
   
       app.UseUHeadlessGraphQLEndpoint();
   
       app.UseUmbraco()
       /* etc... */
   }
   

With these configurations in place, your content will be available at /graphql. To get started, try adding some content to the root and run the following query:

{
  contentAtRoot {
    nodes {
      id,
      name
    }
  }
}

Documentation

For detailed documentation and usage instructions, please refer to the Nikcio.UHeadless Documentation.

Extending Packages

Nikcio.UHeadless offers various packages for extending its functionality. The following table lists the available packages and their current status:

*Included indicates that the package is included in the Nikcio.UHeadless NuGet package.

**Preview indicates that the package is available in a preview version.

Please note that if a Nikcio.UHeadless.* package is not listed above, it either means that the package is not ready for use or it is a core/base package used in the packages mentioned above.

Versioning

Nikcio.UHeadless follows the principles of Semantic Versioning to ensure consistency. The version numbers have the following meaning:

vX.Y.Z

• X (Major): Indicates a breaking change.
• Y (Minor): Signifies a feature change.
• Z (Patch): Represents bug fixes.

It is important to note that the versioning of Nikcio.UHeadless does not align with Umbraco's major versions. To manage compatibility, the following versioning tactic has been adopted:

Versioning Tactic

Each Umbraco LTS (Long-Term Support) version is associated with a corresponding UHeadless LTS version. Any other UHeadless majors that are not marked as LTS will cease to receive support when a new major version is released. This approach allows you, as a developer, to choose the frequency of updates for both UHeadless and Umbraco.

The versioning tracks are as follows:

Please note that LTS versions do not receive new features but will receive bug fixes when a newer major version is available.

Contributing

We welcome contributions to Nikcio.UHeadless. Please refer to the Contributing Guide for more information on how to get involved.

Sponsor Nikcio.UHeadless Development

If you find Nikcio.UHeadless valuable and would like to support its ongoing development, consider sponsoring the project through GitHub Sponsors. Your sponsorship helps ensure the continued improvement and maintenance of this package. Thank you for your support!