Kentico.Xperience.NewsFeed 1.0.1

Xperience by Kentico News Feed

Package	NuGet
Kentico.Xperience.NewsFeed
Kentico.Xperience.NewsFeed.Admin

Description

An experimental integration to deliver news directly into the Xperience administration.

This project is an example of using headless channels and content in Xperience by Kentico to drive experiences and messaging into channels that were traditionally difficult to reach, while keeping the marketer in control of what's delivered. Contrast this with technologies like RSS feeds or developer-designed HTTP APIs - both of which are often data dumps or based on business rules that aren't very flexible.

• An always up to date list of news about Xperience by Kentico for customers and partners.
• News and insights from a digital agency, delivered into their client's Xperience projects.
• Internal "intranet"-style company updates and news

Screenshots

Requirements

Library Version Matrix

Dependencies

• ASP.NET Core 10.0
• Xperience by Kentico

Other requirements

This integration can serve news content from any source, but it is designed to work with Xperience by Kentico headless channels. The demo project included in this repository includes an example headless channel and headless item for a news feed.

Package Installation

Add the package to your application using the .NET CLI

dotnet add package Kentico.Xperience.NewsFeed.Admin

Quick Start

Use these minimal steps to get the integration running. For a full walkthrough and deeper customization, use Usage Guide.

1. Register News Feed services in your app startup.

   Use examples/DancingGoat/Program.cs as reference and add:

   using Kentico.Xperience.NewsFeed;
   using Kentico.Xperience.NewsFeed.Admin;
   
   builder.Services.AddNewsFeed<NewsFeedGraphqlService>(builder.Configuration);
   

2. Configure the Kentico:NewsFeed section in your appsettings.json.

   Use examples/DancingGoat/appsettings.json as reference:

   "Kentico": {
     "NewsFeed": {
       "EndpointUrl": "https://<your-headless-endpoint>/graphql/<channel-guid>",
       "FeedItemId": "<headless-item-guid>",
       "BearerToken": "<bearer-token>",
       "CacheDurationMinutes": 5
     }
   }
   

3. Register the admin page application attribute.

   Use examples/DancingGoat/Program.cs as reference:

   [assembly: UICategory(
       "DancingGoat.Admin.NewsFeed.Category",
       "Dancing Goat",
       Icons.Cup,
       100)]
   [assembly: UIApplication(
       "Kentico.Xperience.NewsFeed.Admin.Application",
       typeof(NewsFeedTemplatePage),
       "<page-slug>",
       "News Feed",
       "DancingGoat.Admin.NewsFeed.Category",
       Icons.Cup,
       "@kentico/xperience-integrations-news-feed-web-admin/NewsFeed")]
   

   Registering these in your own application gives you full control over how they are presented.

4. Implement and register an INewsFeedService.

   A working example is available in examples/DancingGoat/Services/NewsFeedGraphqlService.cs.

5. Run your application and open Xperience admin.

   Navigate to the registered "News Feed" application page and confirm feed items are loaded.

Full Instructions

View the Usage Guide for more detailed instructions.

Contributing

To see the guidelines for Contributing to Kentico open source software, please see Kentico's CONTRIBUTING.md for more information and follow the Kentico's CODE_OF_CONDUCT.

Instructions and technical details for contributing to this project can be found in Contributing Setup.

License

Distributed under the MIT License. See LICENSE.md for more information.

Support

This project has Kentico Labs limited support.

See SUPPORT.md for more information.

For any security issues see SECURITY.md.