https://github.com/bent10/boox
Search anything, instantly
https://github.com/bent10/boox
boox document-search full-text-search fulltext-search fuzzy-matching fuzzy-search instantsearch inverted-index nlp search search-engine search-index tf-idf tfidf vector-search vector-space-model
Last synced: 6 months ago
JSON representation
Search anything, instantly
- Host: GitHub
- URL: https://github.com/bent10/boox
- Owner: bent10
- License: mit
- Created: 2024-03-28T17:29:19.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-08T10:54:45.000Z (6 months ago)
- Last Synced: 2025-04-08T11:35:33.442Z (6 months ago)
- Topics: boox, document-search, full-text-search, fulltext-search, fuzzy-matching, fuzzy-search, instantsearch, inverted-index, nlp, search, search-engine, search-index, tf-idf, tfidf, vector-search, vector-space-model
- Language: TypeScript
- Homepage: https://stilearning.com/boox
- Size: 43.7 MB
- Stars: 5
- Watchers: 1
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
# 
Boox
Boox is a lightweight, zero-dependency full-text search library designed for both browser and Node.js. It enables you to efficiently search through multiple documents and datasets, returning relevant results based on your queries.
## Packages
| Package | Description | Version (click for changelog) |
| :-------------------- | :----------------------------------------- | :------------------------------------------------------------------------- |
| [core](packages/core) | The Boox package. | [](packages/core/changelog.md) |
| [cli](packages/cli) | CLI tool to train your datasets with Boox. | [](packages/cli/changelog.md) |
## Documentation
Go to [Boox documentation](https://stilearning.com/boox).
# Integration
Boox is designed to be flexible and can be easily integrated with other libraries and frameworks to enhance your search functionality. The key is to manage the search state and update the UI based on the search results returned by Boox. Here are some examples of how you can integrate Boox with popular tools:
- [Vanilla JavaScript](./examples/vanilla)
- [React](./examples/react)
- [Vue.js](./examples/vue)
- [Svelte](./examples/svelte)
- [Angular](./examples/angular)
- [Next.js](./examples/nextjs)
- [Express.js](./examples/express)
## Contributing
We 💛 issues.
When committing, please conform to [the semantic-release commit standards](https://www.conventionalcommits.org/). Please install `commitizen` and the adapter globally, if you have not already.
```bash
npm i -g commitizen cz-conventional-changelog
```
Now you can use `git cz` or just `cz` instead of `git commit` when committing. You can also use `git-cz`, which is an alias for `cz`.
```bash
git add . && git cz
```
## License
A project by [Stilearning](https://stilearning.com) © 2024.