https://github.com/fergiemcdowall/norch
A search server that can be installed with npm
https://github.com/fergiemcdowall/norch
search search-algorithm search-engine searchbar
Last synced: 24 days ago
JSON representation
A search server that can be installed with npm
- Host: GitHub
- URL: https://github.com/fergiemcdowall/norch
- Owner: fergiemcdowall
- Created: 2013-05-17T18:30:55.000Z (almost 12 years ago)
- Default Branch: master
- Last Pushed: 2025-04-04T13:51:51.000Z (about 1 month ago)
- Last Synced: 2025-04-06T13:08:17.906Z (about 1 month ago)
- Topics: search, search-algorithm, search-engine, searchbar
- Language: JavaScript
- Homepage:
- Size: 16.1 MB
- Stars: 654
- Watchers: 35
- Forks: 45
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[![NPM version][npm-version-image]][npm-url] [![NPM downloads][npm-downloads-image]][npm-url] [![MIT License][license-image]][license-url] [![Build Status][travis-image]][travis-url] [](https://gitter.im/fergiemcdowall/search-index?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
```
___ ___ ___ ___ ___
/\__\ /\ \ /\ \ /\ \ /\__\
/::| | /::\ \ /::\ \ /::\ \ /:/ /
/:|:| | /:/\:\ \ /:/\:\ \ /:/\:\ \ /:/__/
/:/|:| |__ /:/ \:\ \ /::\~\:\ \ /:/ \:\ \ /::\ \ ___
/:/ |:| /\__\ /:/__/ \:\__\ /:/\:\ \:\__\ /:/__/ \:\__\ /:/\:\ /\__\
\/__|:|/:/ / \:\ \ /:/ / \/_|::\/:/ / \:\ \ \/__/ \/__\:\/:/ /
|:/:/ / \:\ /:/ / |:|::/ / \:\ \ \::/ /
|::/ / \:\/:/ / |:|\/__/ \:\ \ /:/ /
/:/ / \::/ / |:| | \:\__\ /:/ /
\/__/ \/__/ \|__| \/__/ \/__/
```
[](https://dashboard.heroku.com/new?button-url=https%3A%2F%2Fgithub.com%2Ffergiemcdowall%2Fnorch&template=https%3A%2F%2Fgithub.com%2Ffergiemcdowall%2Fnorch)
`npm install norch` and then start with `norch`
or programatically:
```javascript
require('norch')(options, function(err, norch) {
// Norch server started on http://localhost:3030 (or the specified host/port)
})
```
**Put stuff in**
`curl -X POST -d @myData.json http://localhost:3030/add`
(where myData.json is a newline separated file of JSON objects)
**Search for hits** ([uses `search-index's` API](https://github.com/fergiemcdowall/search-index/blob/master/docs/search.md))
`http://localhost:3030/search?q={"query":[{"AND":{"*":["usa"]}}]}`
(`http://localhost:3030/search` returns everything)
**Make autosuggest**
`http://localhost:3030/matcher?q=usa`
**Export, import, and replicate an index**
```bash
# create a snapshot on the server (available under /latestSnapshot)
curl -X POST http://localhost:3030/snapshot
# get latest snapshot
curl -X GET http://anotherIndex:3030/latestSnapshot > export.json
# replicate an export file into a new index on another server
curl -X POST -d @export.json http://someOtherServer:3030/import
```
# API
| Endpoint | Method | Response | Typical Use Case |
| :--- | :--- | :--- | :--- |
| [`/add`](docs/API.md#add) | `POST` | status code | Add documents to the index |
| [`/availableFields`](docs/API.md#availablefields) | `GET` | stream | Discover the name of fields which can be searched in |
| [`/buckets`](docs/API.md#buckets) | `GET` | stream | Aggregate documents on ranges of metadata |
| [`/categorize`](docs/API.md#categorize) | `GET` | stream | Aggregate documents on single metadata values |
| [`/concurrentAdd`](docs/API.md#concurrentadd) | `POST` | status code | For when more than one source is adding documents to the index at the same time |
| [`/createSnapshot`](docs/API.md#createsnapshot) | `POST` | status code | Create a snapshot of the index |
| [`/delete`](docs/API.md#delete) | `DELETE` | status code | Remove documents from index |
| [`/docCount`](docs/API.md#doccount) | `GET` | object | Counts total document in index |
| [`/flush`](docs/API.md#flush) | `DELETE` | status code | Remove all documents from index |
| [`/get`](docs/API.md#get-1) | `GET` | stream | Get documents by ID |
| [`/import`](docs/API.md#import) | `POST` | file | Import/merge an existing index into this one |
| [`/latestSnapshot`](docs/API.md#latestsnapshot) | `GET` | file | Download the latest index snapshot |
| [`/listSnapshots`](docs/API.md#listsnapshots) | `GET` | file | See list of snapshots |
| [`/match`](docs/API.md#match) | `GET` | stream | Match by linguistic similarity- autosuggest, autocomplete |
| [`/search`](docs/API.md#search) | `GET` | stream | Search in the index |
| [`/totalHits`](docs/API.md#totalhits) | `GET` | object | Show number of hits that a given query returns |
The Norch API docs [are here](docs/API.md). Norch is essentially an http wrapper around [search-index](https://www.npmjs.com/package/search-index).
# About Norch
Norch.js is an experimental search engine built with
[Node.js](http://nodejs.org/) and
[search-index](https://github.com/fergiemcdowall/search-index)
featuring, Full text search, Stopword removal, aggregation Matching
(Autosuggest), Phrase search, Fielded search, Field weighting,
Relevance weighting (tf-idf), Paging (offset and resultset length)
# Logging
On Linux and OSX. Install `bunyan`, tail the log-file and pipe to bunyan.
Install bunyan:
```console
npm install -g bunyan
````
Tail log-file:
```console
tail -f log-info.log |bunyan
````
**Mailing list:** [email protected] - subscribe by sending an email to [email protected]
# License
MIT, Copyright (c) 2013-16 Fergus McDowall
[license-image]: http://img.shields.io/badge/license-MIT-blue.svg?style=flat
[license-url]: https://github.com/fergiemcdowall/norch/blob/master/README.md#license
[npm-url]: https://npmjs.org/package/norch
[npm-version-image]: http://img.shields.io/npm/v/norch.svg?style=flat
[npm-downloads-image]: http://img.shields.io/npm/dm/norch.svg?style=flat
[travis-url]: http://travis-ci.org/fergiemcdowall/norch
[travis-image]: http://img.shields.io/travis/fergiemcdowall/norch.svg?style=flat