https://github.com/thbst16/dotnet-lucene-search

Web application that exposes full text search capability built on top of the Lucene.Net search engine library. The repository has 5 sub-projects, documenting the buildup of search features.
https://github.com/thbst16/dotnet-lucene-search

blazor dotnet-core fulltext-search lucene-net

Last synced: about 1 year ago
JSON representation

Web application that exposes full text search capability built on top of the Lucene.Net search engine library. The repository has 5 sub-projects, documenting the buildup of search features.

• Host: GitHub
• URL: https://github.com/thbst16/dotnet-lucene-search
• Owner: thbst16
• License: apache-2.0
• Created: 2022-10-26T14:26:34.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-11-16T23:24:19.000Z (over 1 year ago)
• Last Synced: 2025-03-24T08:47:27.648Z (over 1 year ago)
• Topics: blazor, dotnet-core, fulltext-search, lucene-net
• Language: HTML
• Homepage: https://dotnet-lucene-search.wittycoast-850643a6.eastus.azurecontainerapps.io/
• Size: 3.78 MB
• Stars: 14
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# dotnet-lucene-search

[![Build Status](https://beckshome.visualstudio.com/dotnet-lucene-search/_apis/build/status/thbst16.dotnet-lucene-search?branchName=main)](https://beckshome.visualstudio.com/dotnet-lucene-search/_build/latest?definitionId=14&branchName=main)

![Docker Image Version (latest by date)](https://img.shields.io/docker/v/thbst16/dotnet-lucene-search?logo=docker)

[Dotnet Lucene Search](https://dotnet-lucene-search.wittycoast-850643a6.eastus.azurecontainerapps.io/) is a [Blazor](https://dotnet.microsoft.com/en-us/apps/aspnet/web-apps/blazor)-based web application that exposes full text search capability built on top of the [Lucene.Net](https://lucenenet.apache.org/) search engine library. The application was built to fill the void in tutorials focused on command line interaction with Lucene and Blazor web apps focused on database persistence without full text search capabilities.

The repository has 5 sub-projects, each representing a stage of the application buildout, correlating with the steps used to build out the Azure Cognitive search app in [Microsoft's online tutorial](https://learn.microsoft.com/en-us/azure/search/tutorial-csharp-create-first-app).

* [Basic Search.](https://beckshome.com/2022/10/lucene-blazor-part-1-basic-search) Creation of the basic search web application using Lucene.Net with waffle text source data seeded using the Bogus synthetic test data library.

* [Results Paging.](https://beckshome.com/2022/11/lucene-blazor-part-2-results-paging) Order of magnitude increase in generated records and introduction of paging function to deal with paginated results.

* [AutoComplete.](https://beckshome.com/2022/11/lucene-blazor-part-3-auto-complete) Uses the Lucene.Net.Suggest library in conjunction with Chris Saintly's [Blazored.Typeahead control](https://github.com/Blazored/Typeahead) to provide auto-complete functionality over the indexed waffle text data. 

* [Faceting.](https://beckshome.com/2022/11/lucene-blazor-part-4-faceting) Includes dedicated indexing for 2 facets (scholars and universities) and the ability to drill down on these 2 facets from the user interface.

* [Highlighting.](https://beckshome.com/2022/11/lucene-blazor-part-5-highlighting) Employs a simple utility function to highlight the searched text in the title and body of the returned Waffletext results.

# Screens

### Basic Search Page

![Basic Search](https://s3.amazonaws.com/s3.beckshome.com/20221029-dotnet-lucene-search-basic.jpeg)

### Results Pagination

![Results Paging](https://s3.amazonaws.com/s3.beckshome.com/20221104-dotnet-lucene-search-pagination.jpeg)

### Auto Complete

![Auto Complete](https://s3.amazonaws.com/s3.beckshome.com/20221111-dotnet-lucene-auto-complete.jpeg)

### Faceting

![Faceting](https://s3.amazonaws.com/s3.beckshome.com/20221120-dotnet-lucene-faceting.jpeg)

### Highlighting

![Highlighting](https://s3.amazonaws.com/s3.beckshome.com/20221122-dotnet-lucene-highlighting.jpeg)

# Features

* Web-based full-text search on top of Lucene.Net search engine library

* Autogeneration of waffle text records using Bogus data generator

* Pagination of large result sets

* Autocomplete lookup across the entire indexed dataset

* Faceted search qualification across multiple facets

* Highlighting of search terms in returned results

# Motivation and Credits

Some starter guides for using Lucene.Net and ideas for this project are attributable to the sources below.

* [Getting Started with Blazored Typeahead](https://chrissainty.com/getting-started-with-blazored-typeahead/)

* [How to Implement Lucene.NET](https://code-maze.com/how-to-implement-lucene-dotnet/)

* [Lucene.Net Simple Facets Example](https://lucenenet.apache.org/docs/4.8.0-beta00008/api/Lucene.Net.Demo/Lucene.Net.Demo.Facet.SimpleFacetsExample.html)

* [Microsoft Azure Cognitive Search Tutorials](https://learn.microsoft.com/en-us/azure/search/tutorial-csharp-create-first-app)