Delaware.Xperience.Typesense 0.1.0-beta-1

This is a prerelease version of Delaware.Xperience.Typesense.

dotnet add package Delaware.Xperience.Typesense --version 0.1.0-beta-1

NuGet\Install-Package Delaware.Xperience.Typesense -Version 0.1.0-beta-1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Delaware.Xperience.Typesense" Version="0.1.0-beta-1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Delaware.Xperience.Typesense --version 0.1.0-beta-1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Delaware.Xperience.Typesense, 0.1.0-beta-1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Delaware.Xperience.Typesense as a Cake Addin
#addin nuget:?package=Delaware.Xperience.Typesense&version=0.1.0-beta-1&prerelease

// Install Delaware.Xperience.Typesense as a Cake Tool
#tool nuget:?package=Delaware.Xperience.Typesense&version=0.1.0-beta-1&prerelease

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Xperience by Kentico Typesense integration by delaware consulting

Description

This integration enables you to create Typesense search collections to collection content of pages (content types with the 'Page' feature enabled) from the Xperience content tree using a code-first approach. To provide a search interface for the collectioned content, developers can use the .NET API, JavaScript API, or the InstantSearch.js library.

Be aware that this integration has been developed by delaware consulting and is not an official Kentico product.

Library Version Matrix

Xperience Version	Library Version
>= 29.0.0	>= 4.1.0
28.x	>= 3.x
>= 26.2.0, < 27.0.0	2.x

Dependencies

Package Installation

Add the package to your application using the .NET CLI

dotnet add package Kentico.Xperience.Typesense

Quick Start

Add configuration from your Typesense account to the ASP.NET Core appsettings.json file:

 "CMSTypesenseSearch": {
 "ApiKey": "<your collectioning API key>",
 "Node": {
   "Host": "<your typesense host (localhost)>",
   "Port": <your typesense port (8108)>,
   "Protocol": "<your typesense protocol (http)>"
 }
},

Define a custom DefaultTypesenseCollectionStrategy implementation to customize how content pages/content items are processed for the collection. See Custom-collection-strategy.md

Add this library to the application services, registering your custom DefaultTypesenseCollectionStrategy and Typesense services

// Program.cs
services.AddKenticoTypesense(configuration);
services.RegisterStrategy<GlobalTypesenseCollectionStrategy>("DefaultStrategy");

Create an collection in Xperience's Administration within the Search application added by this library.
Rebuild the collection in Xperience's Administration within the Search application added by this library.
Display the results on your site with a Razor View 👍.

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

We didn't provide support for this project, but you can submit an issue or a pull request. The feedbacks are welcome.

Product	Compatible and additional computed target framework versions.
.NET	net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed.