https://github.com/rohberg/volto-searchkit-block
Plone block with OpenSearch powered faceted search
https://github.com/rohberg/volto-searchkit-block
compound elasticsearch-queries find fuzzy german opensearch search volto volto-addon volto-block
Last synced: 5 days ago
JSON representation
Plone block with OpenSearch powered faceted search
- Host: GitHub
- URL: https://github.com/rohberg/volto-searchkit-block
- Owner: rohberg
- Created: 2020-12-25T17:05:05.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-26T14:05:19.000Z (about 1 month ago)
- Last Synced: 2025-03-29T19:21:42.863Z (29 days ago)
- Topics: compound, elasticsearch-queries, find, fuzzy, german, opensearch, search, volto, volto-addon, volto-block
- Language: JavaScript
- Homepage:
- Size: 4.31 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Searchkit Block (@rohberg/volto-searchkit-block)
Searching with OpenSearch or ElasticSearch
[](https://www.npmjs.com/package/@rohberg/volto-searchkit-block)
[](https://github.com/rohberg/volto-searchkit-block/actions/workflows/acceptance_multilingual.yml)
[](https://github.com/rohberg/volto-searchkit-block/actions/workflows/acceptance_monolingual.yml)
[](https://github.com/rohberg/volto-searchkit-block/actions/workflows/unit.yml)
[](https://github.com/rohberg/volto-searchkit-block/actions/workflows/code.yml)
## Features
Search block with highly overridable components for searching, filtering and displaying search results. Sometimes also called faceted navigation.
As this search is addressing `OpenSearch/ElasticSearch` with text analysis, the search does understand inflection of words, tolerates typos by fuzzy searching, allows exact search and wildcard search.
See [User documentation](#user-documentation) on how to search.
Matched phrases are shown with highlighted matches.
Additional metadata per result item can be configured easily.
Meta data values are clickable to find related content.
The block is prepared for Matomo analytics.
## Installation
### Plone backend
TODO backend instructions
### OpenSearch / ElasticSearch
TODO OpenSearch
### Volto frontend
Add `volto-searchkit-block` to your `package.json`:
```json
"dependencies": {
"@rohberg/volto-searchkit-block": "^2.0.0"
}
```
Add `@rohberg/volto-searchkit-block` to your add-ons in `volto.config.js`:
```javascript
const addons = ['@rohberg/volto-searchkit-block'];
```
### Configuration of the search block
TODO Configuration of the search block
## Demo
TODO demo
Visit http://localhost:3000/ in a browser, login, and check the awesome new features.
## User instructions
The search is a fuzzy search, that means typos are compensated.
Approximate matches and inflections are found.
To force the match of a search string, precede it with "+".
To exclude matches of a search string, precede it with "-".
Use wildcards to find matches of words that complement the search string.
For exact matches of a search string embrace it with quotation marks.
A search for a word with hyphen is equivalent to a search for the word and the parts of it.
Example: A search for "LSR-Lehrbetrieb" is equivalent to a search for "LSR-Lehrbetrieb LSR Lehrbetrieb"
Words with hyphen are matched by searches for part of the words.
Example: "LSR-Lehrbetrieb" is found by a search for "LSR".
### Multiple search strings
Search results include at least one of the search strings.
# Panel for testing matches
You can test search results on a test panel: `/controlpanel/test-searchkit-querystrings`
Please update the settings according to your deployment: `/controlpanel/volto_searchkit_block_control_panel`
## Development
The development of this add-on is done in isolation using a new approach using pnpm workspaces and latest `mrs-developer` and other Volto core improvements.
For this reason, it only works with pnpm and Volto 18.
### Pre-requisites
- [Node.js](https://6.docs.plone.org/install/create-project.html#node-js)
- [Make](https://6.docs.plone.org/install/create-project.html#make)
- [Docker](https://6.docs.plone.org/install/create-project.html#docker)
### Make convenience commands
Run `make help` to list the available commands.
```text
help Show this help
dev-backend-start-monolingual Start backend dev server
dev-backend-start-multilingual Start backend dev server with two languages
install Installs the add-on in a development environment
start Starts Volto, allowing reloading of the add-on during development
start-monolingual Same as `make start` but with language 'de'
start-multilingual Same as `make start` but with language 'de' and multi lingual
build Build a production bundle for distribution of the project with the add-on
build-deps Build dependencies
i18n Sync i18n
ci-i18n Check if i18n is not synced
format Format codebase
lint Lint, or catch and remove problems, in code base
release Release the add-on on npmjs.org
release-dry-run Dry-run the release of the add-on on npmjs.org
test Run unit tests
ci-test Run unit tests in CI
acceptance-frontend-dev-start-monolingual Start acceptance frontend in development mode
acceptance-frontend-prod-start-monolingual Start acceptance frontend in production mode
acceptance-backend-start-monolingual Start backend acceptance server
ci-acceptance-backend-start-monolingual Start backend acceptance server in headless mode for CI
acceptance-test-monolingual Start Cypress in interactive mode
ci-acceptance-test-monolingual Run cypress tests in headless mode for CI
acceptance-frontend-dev-start-multilingual Start acceptance frontend in development mode
acceptance-frontend-prod-start-multilingual Start acceptance frontend in production mode
acceptance-backend-start-multilingual Start backend acceptance server
ci-acceptance-backend-start-multilingual Start backend acceptance server in headless mode for CI
acceptance-test-multilingual Start Cypress in interactive mode
ci-acceptance-test-multilingual Run cypress tests in headless mode for CI
```
### Development environment set up
It's recommended to start three individual terminal sessions, one each for running the Plone backend, the Volto frontend, and the index server.
All sessions should start from the root directory.
Install backend.
```shell
make dev-backend-install
```
Install the frontend.
```shell
make install
```
### Start developing
Start the backend. Monolingual:
```shell
make dev-backend-start-monolingual
```
or start the multilingual backend:
```shell
make dev-backend-start-monolingual
```
Create a site.
```shell
make create-site-monolingual
```
or create a multilingual site:
```shell
make create-site-multilingual
```
Start the index server. Monolingual:
```shell
make dev-index-start-monolingual
```
or start the index server multilingual:
```shell
make dev-index-start-multilingual
```
In a separate terminal session, start the frontend.
```shell
make start-monolingual
```
or start multilingual:
```shell
make start-multilingual
```
### Lint code
Run ESlint, Prettier, and Stylelint in analyze mode.
```shell
make lint
```
### Format code
Run ESlint, Prettier, and Stylelint in fix mode.
```shell
make format
```
### i18n
Extract the i18n messages to locales.
```shell
make i18n
```
### Unit tests
Run unit tests.
```shell
make test
```
### Run Cypress tests
Run each of these steps in separate terminal sessions.
In the first session, start the frontend in development mode.
```shell
make acceptance-frontend-dev-start-monolingual
```
In the second session, start the backend acceptance server.
```shell
make acceptance-backend-start-monolingual
```
In the third session, start the Cypress interactive test runner.
```shell
make acceptance-test-monolingual
```
Appropriate make commands for **multilingual** Cypress tests are available.
## License
The project is licensed under the MIT license.
## Credits and Acknowledgements 🙏
Crafted with care by **Generated using [Cookieplone (0.7.1)](https://github.com/plone/cookieplone) and [cookiecutter-plone (6f17615)](https://github.com/plone/cookiecutter-plone/commit/6f1761520019010ae3799dfa0c6b999b533d59a7) on 2024-10-26 13:17:25.419878**. A special thanks to all contributors and supporters!