A lightning-fast search API that fits effortlessly into your apps, websites, and workflow
Go to file
Clément Renault 3e53791de3
Merge pull request #508 from meilisearch/contributing
First version of new CONTRIBUTING.md
2022-04-25 13:36:41 +02:00
.github Enforce labelling for the PRs 2022-04-09 23:47:06 +02:00
benchmarks Get rid of the threshold when comparing benchmarks 2022-04-19 15:39:58 +02:00
cli Update version for the next release (v0.26.1) 2022-04-14 11:44:06 +02:00
filter-parser Upgrade the dependencies 2022-03-15 11:17:44 +01:00
flatten-serde-json Prefer using direct method calls instead of using the json macros 2022-04-13 13:12:57 +02:00
helpers Update version for the next release (v0.26.1) 2022-04-14 11:44:06 +02:00
http-ui Merge #483 2022-04-19 11:42:32 +00:00
infos Update version for the next release (v0.26.1) 2022-04-14 11:44:06 +02:00
json-depth-checker Apply code suggestions 2022-04-14 11:14:08 +02:00
milli Merge #505 2022-04-25 09:35:32 +00:00
script format the whole project 2021-06-16 18:33:33 +02:00
.gitignore Change the project to become a workspace with milli as a default-member 2021-02-12 16:15:09 +01:00
.rustfmt.toml format the whole project 2021-06-16 18:33:33 +02:00
bors.toml Update bors.toml 2022-04-13 10:56:56 +02:00
Cargo.toml create the json-depth-checker crate 2022-04-14 11:14:08 +02:00
CONTRIBUTING.md First version of new CONTRIBUTING.md 2022-04-21 19:02:22 +02:00
LICENSE Update LICENSE 2022-02-15 15:52:50 +01:00
README.md First version of new CONTRIBUTING.md 2022-04-21 19:02:22 +02:00

the milli logo

a concurrent indexer combined with fast and relevant search algorithms

Introduction

This repository contains the core engine used in Meilisearch.

It contains a library that can manage one and only one index. Meilisearch manages the multi-index itself. Milli is unable to store updates in a store: it is the job of something else above and this is why it is only able to process one update at a time.

This repository contains crates to quickly debug the engine:

  • There are benchmarks located in the benchmarks crate.
  • The http-ui crate is a simple HTTP dashboard to tests the features like for real!
  • The infos crate is used to dump the internal data-structure and ensure correctness.
  • 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.

How to use it?

Section in WIP

Contributing

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!

Also, we recommend following the CONTRIBUTING.md to create your PR.