mirror of
https://github.com/meilisearch/meilisearch.git
synced 2024-11-26 12:05:05 +08:00
638: Update requitites for source build(rust version) r=MarinPostma a=djKooks Hello, I just found that compile via source has been failed by issue here: ``` error[E0658]: the `#[non_exhaustive]` attribute is an experimental feature --> /Users/kwangin.jung/.cargo/registry/src/github.com-1ecc6299db9ec823/whoami-0.8.1/src/lib.rs:40:1 | 40 | #[non_exhaustive] | ^^^^^^^^^^^^^^^^^ | = note: for more information, see https://github.com/rust-lang/rust/issues/44109 error[E0658]: the `#[non_exhaustive]` attribute is an experimental feature --> /Users/kwangin.jung/.cargo/registry/src/github.com-1ecc6299db9ec823/whoami-0.8.1/src/lib.rs:102:1 | 102 | #[non_exhaustive] | ^^^^^^^^^^^^^^^^^ | = note: for more information, see https://github.com/rust-lang/rust/issues/44109 ``` Seems `#[non_exhaustive]` is a new feature on Rust 1.40.0, so added as pre-requitites. 828: Cleanup readme r=MarinPostma a=tpayet Closes #613 865: Update movie dataset with genre field r=MarinPostma a=bidoubiwa Updated the movie dataset by adding the `genre` field to each movies where the genre could be fetched. The `genre` was fetch for each movie by making a search request on the bigger movie dataset (200mb) using MeilISearch. I make this proposition to make testing and trying more accessible. ```json { "id": "323661", "title": "Mune: Guardian of the Moon", "poster": "https://image.tmdb.org/t/p/w1280/4vzqow7mVUahqA4hHoe2UpQOxy.jpg", "overview": "When a faun named Mune becomes the Guardian of the Moon, little did he had unprepared experience with the Moon and an accident that could put both the Moon and the Sun in danger, including a corrupt titan named Necross who wants the Sun for himself and placing the balance of night and day in great peril. Now with the help of a wax-child named Glim and the warrior, Sohone who also became the Sun Guardian, they go out on an exciting journey to get the Sun back and restore the Moon to their rightful place in the sky.", "release_date": 1423094400, "genre": [ "Animation", "Family", "Adventure", "Fantasy", "Comedy" ] } { "id": "306", "title": "Beverly Hills Cop III", "poster": "https://image.tmdb.org/t/p/w1280/tw9gAhqQcBFX0X0XfVbWqUsmzoU.jpg", "overview": "Back in sunny southern California and on the trail of two murderers, Axel Foley again teams up with LA cop Billy Rosewood. Soon, they discover that an amusement park is being used as a front for a massive counterfeiting ring – and it's run by the same gang that shot Billy's boss.", "release_date": 769741200, "genre": [ "Action", "Comedy", "Crime" ] } ``` Co-authored-by: kwangin.jung <inylove82@gmail.com> Co-authored-by: Thomas Payet <thomas@meilisearch.com> Co-authored-by: Charlotte Vermandel <charlottevermandel@gmail.com>
This commit is contained in:
commit
aa545e5386
61
README.md
61
README.md
@ -2,7 +2,6 @@
|
|||||||
<img src="assets/logo.svg" alt="MeiliSearch" width="200" height="200" />
|
<img src="assets/logo.svg" alt="MeiliSearch" width="200" height="200" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
|
|
||||||
<h1 align="center">MeiliSearch</h1>
|
<h1 align="center">MeiliSearch</h1>
|
||||||
|
|
||||||
<h4 align="center">
|
<h4 align="center">
|
||||||
@ -29,45 +28,43 @@
|
|||||||
For more information about features go to [our documentation](https://docs.meilisearch.com/).
|
For more information about features go to [our documentation](https://docs.meilisearch.com/).
|
||||||
|
|
||||||
<p align="center">
|
<p align="center">
|
||||||
<a href="https://crates.meilisearch.com"><img src="assets/crates-io-demo.gif" alt="crates.io demo gif" /></a>
|
<img src="assets/movies-web-demo.gif" alt="Web interface gif" />
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
> MeiliSearch helps the Rust community find crates on [crates.meilisearch.com](https://crates.meilisearch.com)
|
## ✨ Features
|
||||||
|
|
||||||
## Features
|
|
||||||
* Search as-you-type experience (answers < 50 milliseconds)
|
* Search as-you-type experience (answers < 50 milliseconds)
|
||||||
* Full-text search
|
* Full-text search
|
||||||
* Typo tolerant (understands typos and miss-spelling)
|
* Typo tolerant (understands typos and miss-spelling)
|
||||||
|
* Faceted search and filters
|
||||||
* Supports Kanji characters
|
* Supports Kanji characters
|
||||||
* Supports Synonym
|
* Supports Synonym
|
||||||
* Easy to install, deploy, and maintain
|
* Easy to install, deploy, and maintain
|
||||||
* Whole documents are returned
|
* Whole documents are returned
|
||||||
* Highly customizable
|
* Highly customizable
|
||||||
* RESTful API
|
* RESTful API
|
||||||
* Faceted search and filtering
|
|
||||||
|
|
||||||
## Get started
|
## Getting started
|
||||||
|
|
||||||
### Deploy the Server
|
### Deploy the Server
|
||||||
|
|
||||||
#### Run it using Digital Ocean
|
#### Brew (Mac OS)
|
||||||
|
|
||||||
[![DigitalOcean Marketplace](assets/do-btn-blue.svg)](https://marketplace.digitalocean.com/apps/meilisearch?action=deploy&refcode=7c67bd97e101)
|
|
||||||
|
|
||||||
#### Run it using Docker
|
|
||||||
|
|
||||||
```bash
|
|
||||||
docker run -p 7700:7700 -v $(pwd)/data.ms:/data.ms getmeili/meilisearch
|
|
||||||
```
|
|
||||||
|
|
||||||
#### Installing with Homebrew
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
brew update && brew install meilisearch
|
brew update && brew install meilisearch
|
||||||
meilisearch
|
meilisearch
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Installing with APT
|
#### Docker
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run -p 7700:7700 -v $(pwd)/data.ms:/data.ms getmeili/meilisearch
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Run on Digital Ocean
|
||||||
|
|
||||||
|
[![DigitalOcean Marketplace](assets/do-btn-blue.svg)](https://marketplace.digitalocean.com/apps/meilisearch?action=deploy&refcode=7c67bd97e101)
|
||||||
|
|
||||||
|
#### APT (Debian & Ubuntu)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
echo "deb [trusted=yes] https://apt.fury.io/meilisearch/ /" > /etc/apt/sources.list.d/fury.list
|
echo "deb [trusted=yes] https://apt.fury.io/meilisearch/ /" > /etc/apt/sources.list.d/fury.list
|
||||||
@ -75,7 +72,7 @@ apt update && apt install meilisearch-http
|
|||||||
meilisearch
|
meilisearch
|
||||||
```
|
```
|
||||||
|
|
||||||
#### Download the binary
|
#### Download the binary (Linux & Mac OS)
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
curl -L https://install.meilisearch.com | sh
|
curl -L https://install.meilisearch.com | sh
|
||||||
@ -84,7 +81,7 @@ curl -L https://install.meilisearch.com | sh
|
|||||||
|
|
||||||
#### Compile and run it from sources
|
#### Compile and run it from sources
|
||||||
|
|
||||||
If you have the Rust toolchain already installed on your local system, clone the repository and change it to your working directory.
|
If you have the latest stable Rust toolchain installed on your local system, clone the repository and change it to your working directory.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/meilisearch/MeiliSearch.git
|
git clone https://github.com/meilisearch/MeiliSearch.git
|
||||||
@ -165,33 +162,31 @@ We also deliver an **out-of-the-box web interface** in which you can test MeiliS
|
|||||||
|
|
||||||
You can access the web interface in your web browser at the root of the server. The default URL is [http://127.0.0.1:7700](http://127.0.0.1:7700). All you need to do is open your web browser and enter MeiliSearch’s address to visit it. This will lead you to a web page with a search bar that will allow you to search in the selected index.
|
You can access the web interface in your web browser at the root of the server. The default URL is [http://127.0.0.1:7700](http://127.0.0.1:7700). All you need to do is open your web browser and enter MeiliSearch’s address to visit it. This will lead you to a web page with a search bar that will allow you to search in the selected index.
|
||||||
|
|
||||||
<p align="center">
|
| [See the gif above](#demo)
|
||||||
<img src="assets/movies-web-demo.gif" alt="Web interface gif" />
|
|
||||||
</p>
|
|
||||||
|
|
||||||
### Documentation
|
## Documentation
|
||||||
|
|
||||||
Now that your MeiliSearch server is up and running, you can learn more about how to tune your search engine in [the documentation](https://docs.meilisearch.com).
|
Now that your MeiliSearch server is up and running, you can learn more about how to tune your search engine in [the documentation](https://docs.meilisearch.com).
|
||||||
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Hey! We're glad you're thinking about contributing to MeiliSearch! If you think something is missing or could be improved, please open issues and pull requests. If you'd like to help this project grow, we'd love to have you! To start contributing, checking [issues tagged as "good-first-issue"](https://github.com/meilisearch/MeiliSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) is a good start!
|
Hey! We're glad you're thinking about contributing to MeiliSearch! If you think something is missing or could be improved, please open issues and pull requests. If you'd like to help this project grow, we'd love to have you! To start contributing, checking [issues tagged as "good-first-issue"](https://github.com/meilisearch/MeiliSearch/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) is a good start!
|
||||||
|
|
||||||
### Analytic Events
|
## Telemetry
|
||||||
|
|
||||||
Every hour, events are being sent to our Amplitude instance so we can know how many people are using MeiliSearch.<br/>
|
MeiliSearch collects anonymous data regarding general usage.
|
||||||
|
This helps us better understand developers usage of MeiliSearch features.<br/>
|
||||||
To see what information we're retrieving, please see the complete list [on the dedicated issue](https://github.com/meilisearch/MeiliSearch/issues/720).<br/>
|
To see what information we're retrieving, please see the complete list [on the dedicated issue](https://github.com/meilisearch/MeiliSearch/issues/720).<br/>
|
||||||
We also use Sentry to make us crash and error reports. If you want to know more about what Sentry collects, please visit their [privacy policy website](https://sentry.io/privacy/).<br/>
|
We also use Sentry to make us crash and error reports. If you want to know more about what Sentry collects, please visit their [privacy policy website](https://sentry.io/privacy/).<br/>
|
||||||
If this doesn't suit you, you can disable these analytics by using the `MEILI_NO_ANALYTICS` env variable.
|
This program is optionnal, you can disable these analytics by using the `MEILI_NO_ANALYTICS` env variable.
|
||||||
|
|
||||||
## Contact
|
## 💌 Contact
|
||||||
|
|
||||||
Feel free to contact us about any questions you may have:
|
Feel free to contact us about any questions you may have:
|
||||||
* At [bonjour@meilisearch.com](mailto:bonjour@meilisearch.com): English or French is welcome! 🇬🇧 🇫🇷
|
* At [bonjour@meilisearch.com](mailto:bonjour@meilisearch.com)
|
||||||
* Via the chat box available on every page of [our documentation](https://docs.meilisearch.com/) and on [our landing page](https://www.meilisearch.com/).
|
* Via the chat box available on every page of [our documentation](https://docs.meilisearch.com/) and on [our landing page](https://www.meilisearch.com/).
|
||||||
* 🆕 Join our [GitHub Discussions forum](https://github.com/meilisearch/MeiliSearch/discussions) (BETA hype!)
|
* 🆕 Join our [GitHub Discussions forum](https://github.com/meilisearch/MeiliSearch/discussions)
|
||||||
* Join our [Slack community](https://slack.meilisearch.com/).
|
* Join our [Slack community](https://slack.meilisearch.com/).
|
||||||
* By opening an issue.
|
* By opening an issue.
|
||||||
|
|
||||||
Any suggestion or feedback is highly appreciated. Thank you for your support!
|
MeiliSearch is developed by [Meili](https://www.meilisearch.com), a young company. To know more about us, you can [read our blog](https://blog.meilisearch.com). Any suggestion or feedback is highly appreciated. Thank you for your support!
|
||||||
|
File diff suppressed because it is too large
Load Diff
Loading…
Reference in New Issue
Block a user