pelias
/
api
mirror of https://github.com/pelias/api.git
1
0
Fork 0
Code Issues Releases Activity
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.
429 Commits
67 Branches
133 Tags
4.7 MiB
 
 
Tree: 708c24195d
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '708c24195d'
${ noResults }
Harish Krishna 708c24195d
adding admin_boost 		10 years ago
controller fixing layers related bug - adding a default_layers_set flag to clean obj. 10 years ago
docs Documentation and some ciao tests 10 years ago
helper moving all query parsing logic into its own helper. Tests to come 10 years ago
middleware big fix - err is of type string if there is an error within express app - its of type object (with .message being string) in case of errors messages from the ES cluster 10 years ago
query adding admin_boost 10 years ago
sanitiser moving all query parsing logic into its own helper. Tests to come 10 years ago
service add logging for elasticsearch query execution time 10 years ago
src Replace src/logger with pelias-logger. 10 years ago
test adding admin_boost 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 Revert "Add acceptance tests to travis-ci scripts" 10 years ago
DOCS.md DOCS.md: remove bbox from the /reverse parameters. 10 years ago
EXAMPLES.md add examples 10 years ago
README.md Document the pelias-config accessLog option. 10 years ago
app.js adding 408.js 10 years ago
index.js fixing all the js lint related issues (lintified) 10 years ago
package.json Merge branch 'production' of github.com:pelias/api into ngram-address-parser 10 years ago

README.md

Build Status

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

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.