chiehwen / elastic.js

A JavaScript implementation of the elasticsearch Query DSL

elastic.js

A JavaScript implementation of the ElasticSearch Query DSL and Core API.

Documentation

You can find the official documentation at the following locations:

• User Guide
• API Documentation

You will also be able to find unofficial documentation and examples on on our blog and GitHub Gist pages here and here.

Examples

You can find some basic examples in the examples directory. To run the examples you need to have node.js installed and have built elastic.js from source. Start an instance of ElasticSearch using the default settings so it is available at localhost:9200.

Angular and jQuery Examples

These examples need to served from a web server. We have provided a very basic web server written in Node.js for this purpose.

1. Navigate to the examples directory.
2. Run server.js: node server.js.
3. Open Angular Example or jQuery Example.

Node.js Example

The Node.js example is a basic command line tool that accepts a set of query terms, executes the query, and prints the results.

1. Install required modules with npm install.
2. Run findtweets.js with your query terms: node findtweets.js elas*

Contributing

In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using grunt.

Also, please don't edit elastic.js and elastic.min.js files as they are generated via grunt. You'll find source code in the "src" subdirectory!

License

Copyright (c) 2012 FullScale Labs, LLC Licensed under the MIT license.