Skip to content

Commit

Permalink
feat(Sample): replace Example code with full Sample project
Browse files Browse the repository at this point in the history
  • Loading branch information
seangwright committed Aug 1, 2023
1 parent 6d5b834 commit 8f25b29
Show file tree
Hide file tree
Showing 350 changed files with 32,368 additions and 208 deletions.
7 changes: 6 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -364,4 +364,9 @@ healthchecksdb
segments_2i

# Generated files
**/Client/dist/*
**/Client/dist/*

**/CMSModules/WebFarm/*

# Lucene Search
**/App_Data/LuceneSearch/*
33 changes: 33 additions & 0 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
// Use IntelliSense to learn about possible attributes.
// Hover to view descriptions of existing attributes.
// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
"version": "0.2.0",
"configurations": [
{
"name": ".NET Core Launch (web)",
"type": "coreclr",
"request": "launch",
"preLaunchTask": "build",
"program": "${workspaceFolder}/src/Kentico.Xperience.Lucene.Sample/bin/Debug/net6.0/DancingGoat.dll",
"args": [],
"cwd": "${workspaceFolder}/src/Kentico.Xperience.Lucene.Sample",
"stopAtEntry": false,
"serverReadyAction": {
"action": "openExternally",
"pattern": "\\bNow listening on:\\s+(https?://\\S+)"
},
"env": {
"ASPNETCORE_ENVIRONMENT": "Development"
},
"sourceFileMap": {
"/Views": "${workspaceFolder}/Views"
}
},
{
"name": ".NET Core Attach",
"type": "coreclr",
"request": "attach"
}
]
}
7 changes: 7 additions & 0 deletions .vscode/tasks.json
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,13 @@
"problemMatcher": [],
"label": "npm: start - src/Kentico.Xperience.Lucene/Admin/Client",
"detail": "webpack serve --mode development"
},
{
"type": "dotnet",
"task": "watch DancingGoat",
"file": "d:\\dev\\kentico\\community\\xperience-by-kentico-lucene\\src\\Kentico.Xperience.Lucene.Sample\\DancingGoat.csproj",
"problemMatcher": ["$msCompile"],
"label": "dotnet: watch DancingGoat"
}
]
}
16 changes: 11 additions & 5 deletions Kentico.Xperience.Lucene.sln
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,9 @@ VisualStudioVersion = 17.5.33516.290
MinimumVisualStudioVersion = 10.0.40219.1
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Kentico.Xperience.Lucene", "src\Kentico.Xperience.Lucene\Kentico.Xperience.Lucene.csproj", "{52F11256-9F81-4FC1-A2EF-37B113A8F242}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Kentico.Xperience.Lucene.Examples", "src\Kentico.Xperience.Lucene.Examples\Kentico.Xperience.Lucene.Examples.csproj", "{61CA4DBA-2ECD-4F51-BF8A-140190070A8C}"
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{A94EE676-9ABE-44EA-BF9E-22004E9D54C9}"
EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DancingGoat", "src\Kentico.Xperience.Lucene.Sample\DancingGoat.csproj", "{F1CA0C86-BC78-491F-A57A-8CF91C2B514B}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Expand All @@ -17,14 +19,18 @@ Global
{52F11256-9F81-4FC1-A2EF-37B113A8F242}.Debug|Any CPU.Build.0 = Debug|Any CPU
{52F11256-9F81-4FC1-A2EF-37B113A8F242}.Release|Any CPU.ActiveCfg = Release|Any CPU
{52F11256-9F81-4FC1-A2EF-37B113A8F242}.Release|Any CPU.Build.0 = Release|Any CPU
{61CA4DBA-2ECD-4F51-BF8A-140190070A8C}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{61CA4DBA-2ECD-4F51-BF8A-140190070A8C}.Debug|Any CPU.Build.0 = Debug|Any CPU
{61CA4DBA-2ECD-4F51-BF8A-140190070A8C}.Release|Any CPU.ActiveCfg = Release|Any CPU
{61CA4DBA-2ECD-4F51-BF8A-140190070A8C}.Release|Any CPU.Build.0 = Release|Any CPU
{F1CA0C86-BC78-491F-A57A-8CF91C2B514B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{F1CA0C86-BC78-491F-A57A-8CF91C2B514B}.Debug|Any CPU.Build.0 = Debug|Any CPU
{F1CA0C86-BC78-491F-A57A-8CF91C2B514B}.Release|Any CPU.ActiveCfg = Release|Any CPU
{F1CA0C86-BC78-491F-A57A-8CF91C2B514B}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
GlobalSection(SolutionProperties) = preSolution
HideSolutionNode = FALSE
EndGlobalSection
GlobalSection(NestedProjects) = preSolution
{52F11256-9F81-4FC1-A2EF-37B113A8F242} = {A94EE676-9ABE-44EA-BF9E-22004E9D54C9}
{F1CA0C86-BC78-491F-A57A-8CF91C2B514B} = {A94EE676-9ABE-44EA-BF9E-22004E9D54C9}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {1B2A20BC-F57B-4AAE-B1C2-E4DC52EFCAC5}
EndGlobalSection
Expand Down
10 changes: 8 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ Helps with indexing and searching data with Lucene .NET.

> Current version is PRE RELEASE !!!
![](./images/dancing-goat-search-results.jpg)

## Getting Started

### Prerequisites
Expand All @@ -27,7 +29,7 @@ dotnet add package Kentico.Xperience.Lucene
```csharp
builder.Services.AddKentico();
// ... other registrations
builder.Services.AddLucene(builder.Configuration, new[]
builder.Services.AddLucene(new[]
{
// use your own index definition
new LuceneIndex(
Expand All @@ -41,6 +43,10 @@ builder.Services.AddLucene(builder.Configuration, new[]

## Usage

- Review the "Search" functionality in the `src\Kentico.Xperience.Lucene.Sample` Dancing Goat project to see how to implement search.
- Read the Lucene.NET [introduction](https://lucenenet.apache.org/) or [full documentation](https://lucenenet.apache.org/docs/4.8.0-beta00016/) to explore the core library's APIs and functionality.
- Explore the [Lucene.NET source on GitHub](https://github.com/apache/lucenenet)

## Contributing

- .NET SDK >= 7.0.109
Expand All @@ -52,7 +58,7 @@ builder.Services.AddLucene(builder.Configuration, new[]
- <https://nodejs.org/en/download>
- <https://github.com/coreybutler/nvm-windows>

For Contributing please see [`CONTRIBUTING.md`](https://github.com/Kentico/.github/blob/main/CONTRIBUTING.md) for more information.
For Contributing please see [`CONTRIBUTING.md`](https://github.com/Kentico/.github/blob/main/CONTRIBUTING.md) for more information and follow the [`CODE_OF_CONDUCT`](https://github.com/Kentico/.github/blob/main/CODE_OF_CONDUCT.md).

## License

Expand Down
Binary file added images/dancing-goat-search-results.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

This file was deleted.

This file was deleted.

This file was deleted.

This file was deleted.

19 changes: 0 additions & 19 deletions src/Kentico.Xperience.Lucene.Examples/KBankNews/README.md

This file was deleted.

This file was deleted.

14 changes: 14 additions & 0 deletions src/Kentico.Xperience.Lucene.Sample/.config/dotnet-tools.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
{
"version": 1,
"isRoot": true,
"tools": {
"kentico.xperience.dbmanager": {
"version": "26.4.0",
"commands": [
"kentico-xperience-dbmanager"
]
}
}
}


Loading

0 comments on commit 8f25b29

Please sign in to comment.