![Gitter](https://badges.gitter.im/Join Chat.svg)
See our API Documentation.
The API uses elasticsearch scripts for additional scoring/sorting logic. You must install them, as documented here. Failure to do so will result in the following error:
ElasticsearchIllegalArgumentException[Unable to find on disk script admin_boost]
Once you are done with installing the scripts, Run the following
npm install
The API ships with several convenience commands (runnable via npm
):
npm start
: start the servernpm test
: run unit testsnpm run ciao
: run functional tests (this requires that the server be running)npm run docs
: generate API documentationnpm run coverage
: generate code coverage reports
The API recognizes the following properties under the top-level api
key in your pelias.json
config file:
accessLog
: (optional) The name of the format to use for access logs; may be any one of the predefined values in themorgan
package. Defaults to"common"
; if set tofalse
, or an otherwise falsy value, disables access-logging entirely.
Please fork and pull request against upstream master on a feature branch. Pretty please; provide unit tests and script
fixtures in the test
directory.