1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/meilisearch_ynh.git synced 2024-09-03 19:45:59 +02:00
meilisearch_ynh/README.md

51 lines
2 KiB
Markdown
Raw Normal View History

2023-04-17 15:51:03 +02:00
<!--
2024-03-29 02:39:35 +01:00
N.B.: This README was automatically generated by <https://github.com/YunoHost/apps/tree/master/tools/readme_generator>
2023-04-17 15:51:03 +02:00
It shall NOT be edited by hand.
-->
2020-05-16 19:20:53 +02:00
2023-04-17 15:51:03 +02:00
# MeiliSearch for YunoHost
2024-07-02 03:45:13 +02:00
[![Integration level](https://dash.yunohost.org/integration/meilisearch.svg)](https://ci-apps.yunohost.org/ci/apps/meilisearch/) ![Working status](https://ci-apps.yunohost.org/ci/badges/meilisearch.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/meilisearch.maintain.svg)
2023-04-17 15:51:03 +02:00
[![Install MeiliSearch with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=meilisearch)
2020-05-16 19:20:53 +02:00
2024-04-02 23:52:34 +02:00
*[Read this README in other languages.](./ALL_README.md)*
2020-05-16 19:20:53 +02:00
2024-03-29 02:39:35 +01:00
> *This package allows you to install MeiliSearch quickly and simply on a YunoHost server.*
> *If you don't have YunoHost, please consult [the guide](https://yunohost.org/install) to learn how to install it.*
2020-05-16 19:20:53 +02:00
## Overview
2023-04-17 15:51:03 +02:00
Lightning Fast, Ultra Relevant, and Typo-Tolerant Search Engine
2020-05-16 19:20:53 +02:00
2024-03-29 02:39:35 +01:00
2024-08-27 03:44:39 +02:00
**Shipped version:** 1.10.0~ynh1
2023-04-17 22:53:10 +02:00
2024-03-15 02:39:54 +01:00
**Demo:** <https://where2watch.meilisearch.com/>
2023-04-17 22:48:53 +02:00
2020-05-16 19:20:53 +02:00
## Screenshots
2023-04-17 22:47:53 +02:00
![Screenshot of MeiliSearch](./doc/screenshots/meilisearch.png)
2020-05-16 19:20:53 +02:00
2023-04-17 15:51:03 +02:00
## Documentation and resources
2020-05-16 19:20:53 +02:00
2024-03-15 02:39:54 +01:00
- Official app website: <https://www.meilisearch.com/>
- Official admin documentation: <https://www.meilisearch.com/docs>
- Upstream app code repository: <https://github.com/meilisearch/meilisearch/>
- YunoHost Store: <https://apps.yunohost.org/app/meilisearch>
- Report a bug: <https://github.com/YunoHost-Apps/meilisearch_ynh/issues>
2020-05-16 19:20:53 +02:00
2023-04-17 15:51:03 +02:00
## Developer info
2020-05-16 19:20:53 +02:00
2024-03-29 02:39:35 +01:00
Please send your pull request to the [`testing` branch](https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing).
2020-05-16 19:20:53 +02:00
2024-03-29 02:39:35 +01:00
To try the `testing` branch, please proceed like that:
2023-04-17 15:51:03 +02:00
2024-03-15 02:39:54 +01:00
```bash
2020-07-27 12:38:40 +02:00
sudo yunohost app install https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing --debug
2020-05-16 19:20:53 +02:00
or
2020-07-27 12:38:40 +02:00
sudo yunohost app upgrade meilisearch -u https://github.com/YunoHost-Apps/meilisearch_ynh/tree/testing --debug
2020-05-16 19:20:53 +02:00
```
2023-04-17 15:51:03 +02:00
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>