An open API service indexing awesome lists of open source software.

https://github.com/eklem/search-index-cookbook

A collection of recipes and how to's on interesting use cases with search-index
https://github.com/eklem/search-index-cookbook

cookbooks javascript norch search search-engine

Last synced: 7 months ago
JSON representation

A collection of recipes and how to's on interesting use cases with search-index

Awesome Lists containing this project

README

          

# search-index and norch cookbook

[![Join the chat at https://gitter.im/fergiemcdowall/search-index][gitter-image]][gitter-url]
[![NPM version][npm-version-image]][npm-url]
[![NPM downloads][npm-downloads-image]][npm-url]
[![MIT License][license-image]][license-url]

## NOT COMPATIBLE WITH LATEST SEARCH-INDEX !!!
Version 0.8.x and 0.9.x of had some changes that makes a good part of the guide outdated. Put a comment [on this issue](https://github.com/eklem/search-index-norch-cookbook/issues/27) to get notification when updated is out.

A collection of recipes and how to's on interesting use cases with [search-index](https://github.com/fergiemcdowall/search-index). Feel free to [suggest a new topic](https://github.com/eklem/search-index-cookbook/issues/new) you want explained. Check the [prerequisits](./doc/reference/prerequisits.md) for getting the most out of the cookbook.

## Topics
- [Autosuggest or autocomplete - how to use the matcher](./doc/topics/autosuggest.md)
- [Autosuggest from the browser search box](./doc/topics/browser-search-box.md)
- [Create your own stopwords list, filter out the weed](./doc/topics/stopwords-filtering-away-garbage.md)
- [Fix 0-result queries with synonyms](./doc/topics/synonyms.md)
- [How to tune relevancy?](./doc/topics/field-weighting.md)
- [Index size and searching speed tradeoffs](./doc/topics/size-speed-tradeoffs.md)
- [Indexing large data sets](./doc/topics/large-datasets.md)

## Pitfalls

- [Data indexed but no search results](./doc/topics/pitfalls.md#data-indexed-but-no-search-results)

## References
- [prerequisits](./doc/reference/prerequisits.md)
- [configuration](./doc/reference/references.md#configuration)
- [document object](./doc/reference/references.md#document-object)
- [query object](./doc/reference/references.md#query-object)
- [stopwords](./doc/reference/references.md#stopwords)
- [matcher](./doc/reference/references.md#matcher)
- [search index](./doc/reference/references.md#search-index)
- [3rd party modules](./doc/reference/3rd-party-modules.md)

## Get up and running with Node and NMP

- [Get it running on system [x]](./doc/get-it-running-on-x.md)

## TODO
Work wery much in progress. A long [list of things yet to do](https://github.com/eklem/search-index-cookbook/issues). And you're more than welcome to [suggest new recipes & topics](https://github.com/eklem/search-index-cookbook/issues/new).

[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat-square
[license-url]: LICENSE

[npm-url]: https://npmjs.org/package/search-index-cookbook
[npm-version-image]: http://img.shields.io/npm/v/search-index-cookbook.svg?style=flat-square
[npm-downloads-image]: http://img.shields.io/npm/dm/search-index-cookbook.svg?style=flat-square
[gitter-url]: https://gitter.im/fergiemcdowall/search-index?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
[gitter-image]: https://img.shields.io/badge/GITTER-join%20chat-green.svg?style=flat-square