norch

NPM version MIT License Join the chat at https://gitter.im/fergiemcdowall/search-index

      ___           ___           ___           ___           ___      
     /\__\         /\  \         /\  \         /\  \         /\__\     
    /::|  |       /::\  \       /::\  \       /::\  \       /:/  /     
   /:|:|  |      /:/\:\  \     /:/\:\  \     /:/\:\  \     /:/__/      
  /:/|:|  |__   /:/  \:\  \   /::\~\:\  \   /:/  \:\  \   /::\  \ ___  
 /:/ |:| /\__\ /:/__/ \:\__\ /:/\:\ \:\__\ /:/__/ \:\__\ /:/\:\  /\__\ 
 \/__|:|/:/  / \:\  \ /:/  / \/_|::\/:/  / \:\  \  \/__/ \/__\:\/:/  / 
     |:/:/  /   \:\  /:/  /     |:|::/  /   \:\  \            \::/  /  
     |::/  /     \:\/:/  /      |:|\/__/     \:\  \           /:/  /   
     /:/  /       \::/  /       |:|  |        \:\__\         /:/  /    
     \/__/         \/__/         \|__|         \/__/         \/__/     

Installation

In the terminal type npm i norch (or install globally with npm i -g norch)

Usage

Invoking from the terminal

Simply type norch and a norch server will be available at http://localhost:3030 (or the port/url of your choosing)

The following options are available

  -V, --version           output the version number
  -p, --port              specify the port (default: 3030)
  -i, --index             specify the location of the index (default: "norch-data")
  -h, --help              display help

Invoking from a node application

const norch = require('norch')

const myNorch = await norch(options)

API

See the online API documentation, or open /api.html on your own norch server.