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.
 
 
Julian Simioni 1753eb5a9c
feat(docker): Run API processes using pelias user
6 years ago
.circleci Update Docker version 6 years ago
bin Avoid NPM when starting Dockerfile 7 years ago
controller Move lots of logging from info to debug 6 years ago
helper Migrate to internal iso3166 defnitions 6 years ago
middleware Move lots of logging from info to debug 6 years ago
public Add a link to the OSM Geocoding Guidelines 7 years ago
query Move lots of logging from info to debug 6 years ago
routes [Fix] Always apply geometric filter for placeholder 7 years ago
sanitizer Migrate to internal iso3166 defnitions 6 years ago
service feat(findbyid): Add lang query param for placeholder 6 years ago
test feat(findbyid): Add lang query param for placeholder 6 years ago
.dockerignore Make .dockerignore node-specific 7 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
.npmrc disable package-lock 7 years ago
.travis.yml Only run semantic-release on production branch 6 years ago
Dockerfile feat(docker): Run API processes using pelias user 6 years ago
LICENSE Update LICENSE 7 years ago
README.md Add `attributionURL` parameter to configuration documentation 6 years ago
app.js Add default route redirecting to /v1 7 years ago
index.js index: revert changes 7 years ago
package.json feat(release): replace semantic-release dep with Travis build stages 6 years ago
schema.js Remove use stricts 7 years ago

README.md

This repository is part of the Pelias project. Pelias is an open-source, open-data geocoder originally sponsored by Mapzen. 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 and the other Pelias services.

NPM

Gitter

Documentation

Full documentation for the Pelias API lives in the pelias/documentation repository.

Install Dependencies

Note: Pelias requires Node.js v6 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
  • npm run config: dump the configuration to the command line, which is useful for debugging configuration issues

pelias-config

The API recognizes the following properties under the top-level api key in your pelias.json config file:

parameter required default description
host yes specifies the url under which the http service is to run
indexName no pelias name of the Elasticsearch index to be used when building queries
relativeScores no true if set to true, confidence scores will be normalized, realistically at this point setting this to false is not tested or desirable
accessLog no 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.
services no service definitions for point-in-polygon, libpostal, placeholder, and interpolation services. If missing (which is not recommended), the services will not be called.
defaultParameters.focus.point.lon
defaultParameters.focus.point.lat
no default coordinates for focus point
targets.layers_by_source
targets.source_aliases
targets.layer_aliases
no custom values for which sources and layers the API accepts (more info).
attributionURL no (autodetedted) The full URL to use for the attribution link returned in all Pelias responses. Pelias will attempt to autodetect this host, but it will often be correct if, for example, there is a proxy between Pelias and its users. This parameter allows setting a specific URL to avoid any such issues

A good starting configuration file includes this section (fill in the service and Elasticsearch hosts as needed):

{
  "esclient": {
    "hosts": [{
      "host": "elasticsearch"
    }]
  },
  "api": {
    "services": {
      "placeholder": {
        "url": "http://placeholder:4100"
      },
      "libpostal": {
        "url": "http://libpostal:8080"
      },
      "pip": {
        "url": "http://pip-service:4200"
      },
      "interpolation": {
        "url": "http://interpolation:4300"
      }
    }
  },
  "logger": {
    "level": "debug"
  }
}

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,
  ...
}

Continuous Integration

Travis tests every release against all supported Node.js versions.

Build Status

Versioning

We rely on semantic-release and Greenkeeper to maintain our module and dependency versions.

Greenkeeper badge