https://github.com/healeycodes/crane-search
🐦 A full-text WebAssembly search engine for static websites. Build, index, and fly.
https://github.com/healeycodes/crane-search
go-wasm jamstack search static-site-search wasm webassembly
Last synced: 4 months ago
JSON representation
🐦 A full-text WebAssembly search engine for static websites. Build, index, and fly.
- Host: GitHub
- URL: https://github.com/healeycodes/crane-search
- Owner: healeycodes
- License: other
- Created: 2021-02-02T02:31:02.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2023-01-20T13:49:15.000Z (over 2 years ago)
- Last Synced: 2024-11-29T20:02:39.994Z (5 months ago)
- Topics: go-wasm, jamstack, search, static-site-search, wasm, webassembly
- Language: Go
- Homepage: https://healeycodes.github.io/crane-search/
- Size: 7.3 MB
- Stars: 44
- Watchers: 4
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Crane 🐦
> My blog post: [WebAssembly Search Tools for Static Sites](https://healeycodes.com/webassembly-search-tools-for-static-websites/)
Crane is a technical demo is inspired by [Stork](https://github.com/jameslittle230/stork) and uses a near-identical configuration file setup. So it had to be named after a bird too.
I wrote it to help me understand how WebAssembly search tools work. Please use Stork instead.
Crane is two programs. The first program scans a group of documents and builds an efficient index. 1MB of text and metadata is turned into a 25KB index (14KB gzipped). The second program is a Wasm module that is sent to the browser along with a little bit of JavaScript glue code and the index. The result is an instant search engine that helps users find web pages as they type.
[Visit the demo](https://healeycodes.github.io/crane-search/)
[](https://healeycodes.github.io/crane-search/)
The full text search engine is powered in part with code from Artem Krylysov's blog post [Let's build a Full-Text Search engine](https://artem.krylysov.com/blog/2020/07/28/lets-build-a-full-text-search-engine/).
No effort has been made to shrink the Wasm binary. See [Reducing the size of Wasm files](https://github.com/golang/go/wiki/WebAssembly#reducing-the-size-of-wasm-files).
## Use it
Describe your document files and their metadata.
```toml
[input]
files = [
{
path = "docs/essays/essay01.txt",
url = "essays/essay01.txt",
title = "Introduction"
},
# etc.
]
[output]
filename = "dist/federalist.crane"
```
Pass the configuration file to the build script. You'll want a fresh index whenever your documents change but you only need to build the Wasm module once ever.
```bash
./build-index.sh federalist.toml
./build-search.sh
```
Host the files from `/dist` on your website (e.g. `wasm_exec.js`, `crane.js`, `crane.wasm`, `federalist.crane`). And away you go!
```javascript
const crane = new Crane("crane.wasm", "federalist.crane");
await crane.load();
const results = crane.query('some keywords');
console.log(results);
```
See the demo inside `/docs` for a basic UI.
## Build demo page
```bash
./gh-pages.sh
```