MeilisearchDotnet 0.0.1-a

⚡ Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine MeiliSearch client written in C#

MeiliSearchDotnet is a client for MeiliSearch written in .NET standard 2.0. MeiliSearch is a powerful, fast, open-source, easy to use and deploy search engine. Both searching and indexing are highly customizable. Features such as typo-tolerance, filters, and synonyms are provided out-of-the-box.

Table of Contents

• 🔧 Installation
• 🚀 Getting started
• 🤖 Compatibility with MeiliSearch

🔧 Installation

dotnet add package MeilisearchDotnet --version 0.0.1-a

https://www.nuget.org/packages/MeilisearchDotnet

🏃‍♀️ Run MeiliSearch

There are many easy ways to download and run a MeiliSearch instance.

For example, if you use Docker:

docker run -it --rm -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey

NB: you can also download MeiliSearch from Homebrew or APT.

🎬 Getting started

Here is a quickstart for a search request

using System;
using System.Threading.Tasks;

using MeilisearchDotnet;
using MeilisearchDotnet.Types;

namespace console
{
    class Program
    {
        static async Task Main(string[] args)
        {
            Meilisearch ms = new Meilisearch("http://localhost:7700", "masterKey");
            SysInfo p = await ms.SysInfo();
            await ms.ChangeHealthTo(false);
            bool k = await ms.IsHealthy();
            Console.WriteLine(k);
        }
    }
}

⚙️ Development Workflow

If you want to contribute, this sections describes the steps to follow.

Tests

# Tests
docker run -d -p 7700:7700 getmeili/meilisearch:latest ./meilisearch --master-key=masterKey --no-analytics
dotnet test
# Build the project
dotnet build

Release

MeiliSearch tools follow the Semantic Versioning Convention.

You must do a PR modifying the file meilisearch-dotnet.csproj with the right version.<br>

<Version>x.x.x</Version>

🤖 Compatibility with MeiliSearch

This package works for MeiliSearch >=0.10.x.