https://github.com/professionalwiki/wikibasefacetedsearch

Enhanced searching interface with drilldown for Wikibase
https://github.com/professionalwiki/wikibasefacetedsearch

elasticsearch faceted-search mediawiki mediawiki-extension wikibase wikibase-extension

Last synced: 1 day ago
JSON representation

Enhanced searching interface with drilldown for Wikibase

• Host: GitHub
• URL: https://github.com/professionalwiki/wikibasefacetedsearch
• Owner: ProfessionalWiki
• License: gpl-2.0
• Created: 2024-11-25T21:37:39.000Z (2 months ago)
• Default Branch: master
• Last Pushed: 2025-01-29T22:30:02.000Z (7 days ago)
• Last Synced: 2025-01-29T23:24:57.947Z (7 days ago)
• Topics: elasticsearch, faceted-search, mediawiki, mediawiki-extension, wikibase, wikibase-extension
• Language: PHP
• Homepage:
• Size: 281 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 19
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Wikibase Faceted Search

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ProfessionalWiki/WikibaseFacetedSearch/ci.yml?branch=master)](https://github.com/ProfessionalWiki/WikibaseFacetedSearch/actions?query=workflow%3ACI)

[![codecov](https://codecov.io/gh/ProfessionalWiki/WikibaseFacetedSearch/branch/master/graph/badge.svg)](https://codecov.io/gh/ProfessionalWiki/WikibaseFacetedSearch)

[![Latest Stable Version](https://poser.pugx.org/professional-wiki/wikibase-faceted-search/v/stable)](https://packagist.org/packages/professional-wiki/wikibase-faceted-search)

[![Download count](https://poser.pugx.org/professional-wiki/wikibase-faceted-search/downloads)](https://packagist.org/packages/professional-wiki/wikibase-faceted-search)

[![License](https://poser.pugx.org/professional-wiki/wikibase-faceted-search/license)](LICENSE)

Wikibase Faceted Search enhances MediaWiki's search with faceted search capabilities. Filter results based on instance type or statement values.

- [Introduction to the extension](TODO)

- [Usage documentation](https://professional.wiki/en/extension/wikibase-faceted-search#Usage)

- [Installation](https://professional.wiki/en/extension/wikibase-faceted-search#Installation)

- [Configuration](https://professional.wiki/en/extension/wikibase-faceted-search#Configuration)

- [Development](#development)

- [Release notes](#release-notes)

Get professional support for this extension via [Professional Wiki], its creators and maintainers.

We provide [MediaWiki Development], [MediaWiki Hosting], and [MediaWiki Consulting] services.

## Development

Run `composer install` in `extensions/WikibaseFacetedSearch/` to make the code quality tools available.

### Running Tests and CI Checks

You can use the `Makefile` by running make commands in the `WikibaseFacetedSearch` directory.

Commands to run in a MediaWiki environment/container:

* `make` or `make ci`: Run everything

* `make test`: Run all PHP tests

* `make phpunit --filter FooBar`: run only PHPUnit tests with FooBar in their name

* `make cs`: Run PHP style checks and static analysis

* `make phpcs`: Run PHP style checks

* `make stan`: Run PHP static analysis

* `make stan-baseline`: Update the PHPStan baseline file (which contains errors we wish to ignore)

Commands that use Docker:

* `make jest` Run JS tests

* `make lint` Lint JS, CSS, and i18n files

* `make js` Run all JS checks

## Release Notes

### Version 1.0.0 - TBD

* TODO

* Compatibility with MediaWiki 1.43

* Compatibility with PHP 8.1 up to (at least) 8.3

[Professional Wiki]: https://professional.wiki

[MediaWiki Hosting]: https://pro.wiki

[MediaWiki Development]: https://professional.wiki/en/mediawiki-development

[MediaWiki Consulting]: https://professional.wiki/en/mediawiki-consulting-services