elasticsearch-lite

elasticsearch-lite

this zero-dependency package will download and install the elasticsearch-v1.7.6 prebuilt-binary from https://download.elastic.co/elasticsearch/elasticsearch

git-branch :	master	beta	alpha
test-server-github :
test-server-heroku :
test-report :
coverage :
build-artifacts :

table of contents

• cdn download
• live demo
• documentation
• quickstart example.js
• all screenshots
• package.json
• changelog of last 50 commits
• internal build script
• misc

cdn download

• none

live demo

• http://h1-elasticsearch-beta.herokuapp.com

• http://h1-elasticsearch-beta.herokuapp.com/kibana/

documentation

apidoc

• https://kaizhu256.github.io/node-elasticsearch-lite/build..beta..travis-ci.org/apidoc.html

swaggerdoc

• http://h1-elasticsearch-beta.herokuapp.com/assets.swgg.html

todo

• persist file data at $PWD/tmp/elasticsearch.data
• none

changelog for v2017.1.7

• npm publish 2017.6.1
• add kibana to buildApp
• enable cors in github
• initial working server
• none

this package requires

• darwin or linux os

additional info

• curl -XPOST 'localhost:9200/bank/account/_bulk?pretty' --data-binary @lib.elasticsearch.accounts.json
• curl -XPOST localhost:9200/_bulk --data-binary @lib.elasticsearch.shakespeare.json

quickstart example.js

to run this example, follow the instruction in the script below

• example.js

/*
example.js

this script will run a web demo of elasticsearch-lite

instruction
    1. save this script as example.js
    2. run the shell command:
        $ npm install elasticsearch-lite && PORT=8081 node example.js
    3. open a browser to http://127.0.0.1:8081 and play with the web demo
    4. edit this script to suit your needs
*/



/* istanbul instrument in package elasticsearch */
/*jslint
    bitwise: true,
    browser: true,
    maxerr: 8,
    maxlen: 96,
    node: true,
    nomen: true,
    regexp: true,
    stupid: true
*/
(function () {
    'use strict';
    if (global.utility2_rollup) {
        return;
    }
    require('elasticsearch-lite').serverStart({ port: Number(process.env.PORT) });
}());

output from browser

output from shell

all screenshots

• https://kaizhu256.github.io/node-elasticsearch-lite/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Fapidoc.html.png

• https://kaizhu256.github.io/node-elasticsearch-lite/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Fcoverage.lib.html.png

• https://kaizhu256.github.io/node-elasticsearch-lite/build/screenshot.buildCi.browser.%252Ftmp%252Fbuild%252Ftest-report.html.png

package.json

{
    "author": "kai zhu <[e-mail]>",
    "bin": {
        "elasticsearch": "lib.elasticsearch.js"
    },
    "description": "this zero-dependency package will download and install the elasticsearch-v1.7.6 prebuilt-binary from https://download.elastic.co/elasticsearch/elasticsearch",
    "devDependencies": {
        "electron-lite": "kaizhu256/node-electron-lite#alpha",
        "utility2": "kaizhu256/node-utility2#alpha"
    },
    "engines": {
        "node": ">=4.0"
    },
    "homepage": "https://github.com/kaizhu256/node-elasticsearch-lite",
    "keywords": [
        "elasticsearch",
        "elasticsearch-lite",
        "search",
        "server"
    ],
    "license": "MIT",
    "main": "lib.elasticsearch.js",
    "name": "elasticsearch-lite",
    "nameAlias": "elasticsearch",
    "nameOriginal": "elasticsearch-lite",
    "os": [
        "darwin",
        "linux"
    ],
    "repository": {
        "type": "git",
        "url": "https://github.com/kaizhu256/node-elasticsearch-lite.git"
    },
    "scripts": {
        "build-ci": "utility2 shReadmeTest build_ci.sh",
        "env": "env",
        "heroku-postbuild": "npm install \"kaizhu256/node-utility2#alpha\"",
        "postinstall": "[ ! -f npm_scripts.sh ] || ./npm_scripts.sh postinstall",
        "start": "PORT=${PORT:-8080} utility2 start test.js",
        "test": "PORT=$(utility2 shServerPortRandom) utility2 test test.js"
    },
    "version": "2017.1.7"
}

changelog of last 50 commits

internal build script

• build_ci.sh

# build_ci.sh

# this shell script will run the build for this package

shBuildCiAfter() {(set -e
    shDeployHeroku
    # screenshot
    MODE_BUILD=deployHeroku shBrowserTest \
        "http://h1-elasticsearch-$CI_BRANCH.herokuapp.com/kibana/" screenshot
    cp doc.html tmp/build/apidoc.html
    MODE_BUILD=buildCi shBrowserTest tmp/build/apidoc.html screenshot
    shReadmeTest example.sh
)}

shBuildCiBefore() {(set -e
    shNpmTestPublished
    shReadmeTest example.js
)}

# run shBuildCi
eval $(utility2 source)
shBuildCi

misc

• this package was created with utility2