{"id":14976045,"url":"https://github.com/nikcio/nikcio.uheadless","last_synced_at":"2025-04-13T02:25:28.471Z","repository":{"id":37011613,"uuid":"406304221","full_name":"nikcio/Nikcio.UHeadless","owner":"nikcio","description":"The easiest way to go headless in Umbraco using GraphQL","archived":false,"fork":false,"pushed_at":"2024-11-21T17:04:39.000Z","size":11709,"stargazers_count":54,"open_issues_count":0,"forks_count":13,"subscribers_count":6,"default_branch":"contrib","last_synced_at":"2024-12-02T03:49:54.980Z","etag":null,"topics":["graphql","graphql-api","headless","headless-cms","umbraco","umbraco-cms","umbraco-v10","umbraco-v11","umbraco-v12","umbraco-v13","umbraco-v9"],"latest_commit_sha":null,"homepage":"https://nikcio.github.io/Nikcio.UHeadless","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nikcio.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"nikcio","patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"lfx_crowdfunding":null,"custom":null}},"created_at":"2021-09-14T09:26:59.000Z","updated_at":"2024-11-20T19:03:46.000Z","dependencies_parsed_at":"2023-01-17T13:16:30.672Z","dependency_job_id":"5e8977d9-1f4d-4bad-95f2-e71afbe80ca1","html_url":"https://github.com/nikcio/Nikcio.UHeadless","commit_stats":{"total_commits":760,"total_committers":7,"mean_commits":"108.57142857142857","dds":0.05657894736842106,"last_synced_commit":"f5638c1703a8548e532059b4fd2fe9cea3cc1c87"},"previous_names":["nikcio/nikcio.umbraco.headless"],"tags_count":56,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikcio%2FNikcio.UHeadless","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikcio%2FNikcio.UHeadless/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikcio%2FNikcio.UHeadless/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nikcio%2FNikcio.UHeadless/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nikcio","download_url":"https://codeload.github.com/nikcio/Nikcio.UHeadless/tar.gz/refs/heads/contrib","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248655657,"owners_count":21140536,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["graphql","graphql-api","headless","headless-cms","umbraco","umbraco-cms","umbraco-v10","umbraco-v11","umbraco-v12","umbraco-v13","umbraco-v9"],"created_at":"2024-09-24T13:53:12.703Z","updated_at":"2025-04-13T02:25:28.445Z","avatar_url":"https://github.com/nikcio.png","language":"C#","funding_links":["https://github.com/sponsors/nikcio","https://github.com/sponsors/nikcio/"],"categories":[],"sub_categories":[],"readme":"# Nikcio.UHeadless\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nikcio_Nikcio.UHeadless\u0026metric=alert_status)](https://sonarcloud.io/summary/new_code?id=nikcio_Nikcio.UHeadless)\n[![Build UHeadless](https://github.com/nikcio/Nikcio.UHeadless/actions/workflows/build.yml/badge.svg)](https://github.com/nikcio/Nikcio.UHeadless/actions/workflows/build.yml)\n![Nuget Downloads](https://img.shields.io/nuget/dt/Nikcio.UHeadless?color=%230078d7\u0026label=Nuget%20downloads\u0026logo=Nuget)\n![Nuget Version](https://img.shields.io/nuget/v/Nikcio.UHeadless?label=Stable%20version)\n![Nuget (with prereleases)](https://img.shields.io/nuget/vpre/Nikcio.UHeadless?label=Prerelease%20version)\n\nWelcome 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.\n\n## Compatibility\n\nThe Nikcio.UHeadless package is compatible with the following Umbraco versions:\n\n| Umbraco version      | Supported Version     |\n|----------------------|-----------------------|\n| Umbraco 10           | v3.x.x                |\n| Umbraco 12           | v4.x.x                |\n| Umbraco 13           | v4.2.x+ \u0026 v5.x.x      |\n| Umbraco 14           | v6.x.x                |\n| Umbraco 15           | v7.x.x \u0026 v8.x.x       |\n\nFor more information, please refer to the [Versioning](#versioning) section.\n\n## Setup\n\n### Installation\n\nTo install the Nikcio.UHeadless package, run the following command:\n\n```shell\ndotnet add Nikcio.UHeadless\n```\n\nYou can also find the package on [NuGet](https://www.nuget.org/packages/Nikcio.UHeadless).\n\n### Integration\n\nTo integrate the package into your project, follow these steps:\n\n1. Open your `Program.cs` file.\n2. Add the following using statements:\n\n    ```csharp\n    using Nikcio.UHeadless;\n    using Nikcio.UHeadless.Defaults.ContentItems;\n    ```\n\n3. On the `UmbracoBuilder`, add the following code:\n\n    ```csharp\n    builder.CreateUmbracoBuilder()\n        // Default Umbraco configuration\n        .AddUHeadless(options =\u003e\n        {\n            options.DisableAuthorization = true; // Change this later when adding authentication - See documentation\n\n            options.AddDefaults();\n\n            options.AddQuery\u003cContentByRouteQuery\u003e();\n            options.AddQuery\u003cContentByGuidQuery\u003e();\n        })\n        .Build();\n    ```\n\n4. Then after the `app.BootUmbracoAsync()` method, add the following code:\n\n    ```csharp\n    await app.BootUmbracoAsync();\n\n    app.UseAuthentication();\n    app.UseAuthorization();\n\n    GraphQLEndpointConventionBuilder graphQLEndpointBuilder = app.MapUHeadless();\n\n    // Only enable the GraphQL IDE in development\n    if (!builder.Environment.IsDevelopment())\n    {\n        graphQLEndpointBuilder.WithOptions(new GraphQLServerOptions()\n        {\n            Tool =\n            {\n                Enable = false,\n            }\n        });\n    }\n\n    app.UseUmbraco()\n        // Default Umbraco configuration\n    ```\n\nWith these configurations in place, your content will be available at `/graphql`. \n\nTo get started, try querying your content using their GUIDs or routes. For example with the query below:\n\n__Tip: GUIDs can be found in the info tab when viewing content in the backoffice__\n\n```graphql\nquery {\n  contentByGuid(id: \"dcf18a51-6919-4cf8-89d1-36b94ce4d963\") {\n    id\n    key\n    name\n    statusCode\n    templateId\n    updateDate\n    url(urlMode: ABSOLUTE)\n    urlSegment\n  }\n}\n```\n\n## Documentation\n\nFor detailed documentation and usage instructions, please refer to the [Nikcio.UHeadless Documentation](https://nikcio.github.io/Nikcio.UHeadless).\n\n## Versioning\n\nNikcio.UHeadless follows the principles of Semantic Versioning to ensure consistency. The version numbers have the following meaning:\n\n```\nvX.Y.Z\n```\n\n- X (Major): Indicates a breaking change.\n- Y (Minor): Signifies a feature change.\n- Z (Patch): Represents bug fixes.\n\n### Full version table\n\n| Umbraco version      | Supported Versions    | Development                           |\n|----------------------|-----------------------|---------------------------------------|\n| Umbraco 9            | v1.x.x \u0026 v2.x.x       | No development                        |\n| Umbraco 10           | v2.x.x \u0026 v3.x.x       | No development                        |\n| Umbraco 11           | v3.x.x \u0026 v4.x.x       | No development                        |\n| Umbraco 12           | v4.x.x                | No development                        |\n| Umbraco 13           | v4.2.x+ \u0026 v5.x.x      | Only reported issues for v5.x.x       |\n| Umbraco 14           | v6.x.x                | No development                        |\n| Umbraco 15           | v7.x.x \u0026 v8.x.x       | Active branch                         |\n\n## Contributing\n\nWe welcome contributions to Nikcio.UHeadless. Please refer to the [Contributing Guide](CONTRIBUTING.md) for more information on how to get involved.\n\n---\n\n**Sponsor Nikcio.UHeadless Development**\n\nIf you find Nikcio.UHeadless valuable and would like to support its ongoing development, consider sponsoring the project through [GitHub Sponsors](https://github.com/sponsors/nikcio/). Your sponsorship helps ensure the continued improvement and maintenance of this package. Thank you for your support!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikcio%2Fnikcio.uheadless","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnikcio%2Fnikcio.uheadless","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnikcio%2Fnikcio.uheadless/lists"}