shuni64/tinysearch

A tiny, static, full-text search engine for your website using Bloom filters and WebAssembly

tinysearch

This is a lightweight, fast, full-text search engine for static websites. I'm using it on my homepage if you like to see a quick demo.

It is a Rust/WASM port of the Python code from the article "Writing a full-text search engine using Bloom filters". This can be seen as an alternative to lunr.js and elasticlunr.

The idea is to generate a small, self-contained WASM module from a list of articles of a website and ship it to browsers. tinysearch could be integrated into the build process of generators like Jekyll, Hugo, zola, or Cobalt.

Installation

wasm-pack is required to build the WASM module. Install it with

cargo install wasm-pack

To optimize JavaScript, you'll also need terser:

npm install terser -g

If you want to make the WebAssembly as small as possible, we recommend that you install binaryen as well. On macOS you can install it using homebrew like so:

brew install binaryen

Alternatively you can download the binary from the release page or use your OS package manager.

After that, you can install tinysearch itself:

cargo install tinysearch

Usage

As an input, we require a JSON file, which contains a list of your blog posts (see file format).

tinysearch fixtures/index.json

This will create a WASM module and the JavaScript glue code to integrate it into your homepage. You can open the demo.html with any webserver to see the result.

For example, if you have Python installed, you can try the following:

python -m SimpleHTTPServer

then browse to http://0.0.0.0:8000/demo.html

For advanced usage options, try

tinysearch --help

Maintainers

• Matthias Endler (@mre)
• Jorge-Luis Betancourt (@jorgelbg)

License

tinysearch is licensed under either of

• Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
• MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)

at your option.