Severyn Kozak a007af3572 Replace src/logger with pelias-logger. (query, query)/*.js -Remove unused `../src/logger` `require()`s. src/logger.js, package.json -Remove `src/logger` in favor of using `pelias-logger` for all logging, since it's the Pelias standard. middleware/500.js -Replace usage of `src/logger` with pelias-logger.		10 years ago
controller	Merge branch 'master' into address-details	10 years ago
docs	Documentation and some ciao tests	10 years ago
helper	Merge pull request #106 from pelias/category-scoring	10 years ago
middleware	Replace src/logger with pelias-logger.	10 years ago
query	Replace src/logger with pelias-logger.	10 years ago
sanitiser	Replace src/logger with pelias-logger.	10 years ago
service	cleanup + tests	10 years ago
src	Replace src/logger with pelias-logger.	10 years ago
test	Merge pull request #117 from pelias/better-bbox-desc	10 years ago
.gitignore	remove code-climate hooks	10 years ago
.jshintignore	remove code-climate hooks	10 years ago
.jshintrc	adding jshintignore and jshintrc, pre commit hook js lint	10 years ago
.travis.yml	remove code-climate hooks	10 years ago
DOCS.md	fix comments and tests	10 years ago
EXAMPLES.md	add examples	10 years ago
README.md	Shotgun edits to the README.	10 years ago
app.js	Add an access log middleware.	10 years ago
index.js	fixing all the js lint related issues (lintified)	10 years ago
package.json	Replace src/logger with pelias-logger.	10 years ago

README.md

API

![Gitter](https://badges.gitter.im/Join Chat.svg)

Documentation

See our API Documentation.

Install Dependencies

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

scripts

The API ships with several convenience commands (runnable via npm):

npm start: start the server
npm test: run unit tests
npm run ciao: run functional tests (this requires that the server be running)
npm run docs: generate API documentation
npm run coverage: generate code coverage reports

Contributing

Please fork and pull request against upstream master on a feature branch. Pretty please; provide unit tests and script fixtures in the test directory.