You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Peter Johnson 6d58898bae tell eshint we allow ECMA6 functions 8 years ago
bin Handle fatal errors in unit tests 9 years ago
controller change the query module interfaces back to simple functions 8 years ago
helper switched `label` to property-to-copy 8 years ago
middleware made `locality` and `localadmin` equivalent in fallback scoring 8 years ago
public Add link to WOF license file 9 years ago
query changed method name 8 years ago
routes moved label assign to before geocodeJSON for all routes 8 years ago
sanitizer Add boundary.rect to geo_autocomplete sanitizer 8 years ago
service moved location of `matched_queries` to correct place 8 years ago
src Pass esclient config to elasticsearch module 9 years ago
test unrolled loop tests 8 years ago
.gitignore Add pids directory to gitignore 9 years ago
.jshintignore remove code-climate hooks 10 years ago
.jshintrc tell eshint we allow ECMA6 functions 8 years ago
.lgtm Add LGTM config 9 years ago
.travis.yml Remove Node.js 0.12 from TravisCI versions 8 years ago
Dockerfile Update Dockerfile to avoid npm install fail 8 years ago
README.md Add readme note about Node 4 8 years ago
app.js Return an object from access_log module 9 years ago
circle.yml fix circle deployments 9 years ago
index.js removed multicore support 8 years ago
package.json chore(package): update pelias-labels to version 1.5.0 8 years ago
pelias.json.docker add default config 9 years ago

README.md

This repository is part of the Pelias project. Pelias is an open-source, open-data geocoder built by Mapzen that also powers Mapzen Search. Our official user documentation is here.

Pelias API Server

This is the API server for the Pelias project. It's the service that runs to process user HTTP requests and return results as GeoJSON by querying Elasticsearch.

Gitter Build Status

Documentation

See the Mapzen Search documentation.

Install Dependencies

Note: Pelias requires Node.js v4 or newer

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

pelias-config

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 the morgan package. Defaults to "common"; if set to false, or an otherwise falsy value, disables access-logging entirely.

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.

Unit tests

You can run the unit test suite using the command:

$ npm test

HTTP tests

We have another set of tests which are used to test the HTTP API layer, these tests send expected HTTP requests and then assert that the responses coming back have the correct geoJSON format and HTTP status codes.

You can run the HTTP test suite using the command:

$ npm run ciao

Note: some of the tests in this suite fail when no data is present in the index, there is a small set of test documents provided in ./test/ciao_test_data which can be inserted in order to avoid these errors.

To inject dummy data in to your local index:

$ node test/ciao_test_data.js

You can confirm the dummy data has been inserted with the command:

$ curl localhost:9200/pelias/_count?pretty
{
  "count" : 9,
  ...
}