snowykami/meilisearch
1
0
Fork 0
mirror of https://github.com/meilisearch/meilisearch.git synced 2025-07-27 16:51:01 +00:00
Code Issues Packages Projects Releases Wiki Activity

First version of new CONTRIBUTING.md

Browse Source
This commit is contained in:
Clémentine Urquizar
2022-04-21 19:02:22 +02:00
parent 71414630fc
commit dc0d4addd9
2 changed files with 134 additions and 39 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -20,50 +20,15 @@ This repository contains crates to quickly debug the engine:
- The `search` crate is a simple command-line that helps run [flamegraph] on top of it.
- The `helpers` crate is only used to modify the database inplace, sometimes.
### Compile and run the HTTP debug server
## How to use it?
You can specify the number of threads to use to index documents and many other settings too.
```bash
cd http-ui
cargo run --release -- --db my-database.mdb -vvv --indexing-jobs 8
```
### Index your documents
It can index a massive amount of documents in not much time, I already achieved to index:
- 115m songs (song and artist name) in \~48min and take 81GiB on disk.
- 12m cities (name, timezone and country ID) in \~4min and take 6GiB on disk.
These metrics are done on a MacBook Pro with the M1 processor.
You can feed the engine with your CSV (comma-separated, yes) data like this:
```bash
printf "id,name,age\n1,hello,32\n2,kiki,24\n" | http POST 127.0.0.1:9700/documents content-type:text/csv
```
Don't forget to specify the `id` of the documents. Also, note that it supports JSON and JSON
streaming: you can send them to the engine by using the `content-type:application/json` and
`content-type:application/x-ndjson` headers respectively.
### Querying the engine via the website
You can query the engine by going to [the HTML page itself](http://127.0.0.1:9700).
_Section in WIP_
## Contributing
You can setup a `git-hook` to stop you from making a commit too fast. It'll stop you if:
- Any of the workspaces does not build
- Your code is not well-formatted
We're glad you're thinking about contributing to this repository! Feel free to pick an issue, and to ask any question you need. Some points might not be clear and we are available to help you!
These two things are also checked in the CI, so ignoring the hook won't help you merge your code.
But if you need to, you can still add `--no-verify` when creating your commit to ignore the hook.
To enable the hook, run the following command from the root of the project:
```
cp script/pre-commit .git/hooks/pre-commit
```
Also, we recommend following the [CONTRIBUTING.md](/CONTRIBUTING.md) to create your PR.
[Meilisearch]: https://github.com/meilisearch/meilisearch
[flamegraph]: https://github.com/flamegraph-rs/flamegraph