Skip to content

Kentico/xperience-by-kentico-aira-unified

Repository files navigation

Xperience by Kentico Aira Unified

Kentico Labs CI: Build and Test NuGet Package

Description

Aira unified integration enabling for alternative administration UI and chatbot which can easily be added to an Xperience By Kentico project.

Screenshots

UI Application

Library Version Matrix

Xperience Version Library Version
>= 30.0.0 >= 0.1.0-prerelase-1

Dependencies

Package Installation

Add the package to your application using the .NET CLI

dotnet add package Kentico.Xperience.AiraUnified

Quick Start

  1. Include Kentico.Xperience.AiraUnified project in the solution.

    dotnet add package Kentico.Xperience.AiraUnified
  2. Register required services into DI container.

    // Program.cs
    
    var builder = WebApplication.CreateBuilder(args);
    
    // ...
    
    builder.Services.AddKenticoAiraUnified();
    
    // ...
    
    var app = builder.Build();
    
    // ...
    
    app.UseAiraUnifiedEndpoints();
    
    app.Run();
  3. In the administration go to UI application 'Aira Unified'.

  4. Fill out the Aira Unified configuration form, populating the fields with your custom values.

  • Relative Path Base - the relative path where the Aira Unified is available. The path is relative to the base url of your application.
  • Logo - the asset selectable from Media Library shown in the top left corner of the Aira Unified pwa.
  • Chat Title - the title displayed on top of the screen of the chat page and the text of chat option in Aira Unified menu.
  • Chat Image - the asset selectable from Media library shown on top of the screen of the chat page and next to the chat option text in Aira Unified menu.
  • Smart Upload Title - the title displayed on top of the screen of the smart upload page and the text of smart upload option in Aira Unified menu.
  • Smart Upload Image - the asset selectable from Media library shown on top of the screen of the smart upload page and next to the smart upload option text in Aira Unified menu.
  1. Return to administration dashboard and select a Content Type used for Mass asset upload. Uploaded assets in the Smart upload page of this integration will be saved under this Content type in the Content hub.
  2. The users can now visit the Aira Unified under the specified path.

Full Instructions

You can view and start the DancingGoat example project.

To activate the communication of AIRA Unified app with the AIRA service, you need to request an activation key. Please contact us at [email protected] for more information.

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

Kentico Labs

This project has Kentico Labs limited support.

See SUPPORT.md for more information.

This feature is currently in a Preview mode, do not use for production instances.

For any security issues see SECURITY.md.