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.
467 Commits
67 Branches
133 Tags
4.7 MiB
 
 
Tree: 3a802b9691
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '3a802b9691'
${ noResults }
Peter Johnson 3a802b9691
Merge branch 'master' of github.com:pelias/api into multicore 		9 years ago
controller Merge branch 'master' into ngram-address-parser 9 years ago
docs Documentation and some ciao tests 10 years ago
helper moving the logic for each of the three parsed addresses out into their own function 9 years ago
middleware timeout is one word 9 years ago
query Revert "match the whole query with phrase.default" 9 years ago
sanitiser moving all query parsing logic into its own helper. Tests to come 9 years ago
service remove all things that involved suggester including query mixer 9 years ago
src Replace src/logger with pelias-logger. 10 years ago
test keys -> key 9 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 update travis to use containers 9 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 remove all things that involved suggester including query mixer 9 years ago
index.js run webserver on all available cores, resolves #6 9 years ago
package.json Merge branch 'master' of github.com:pelias/api into multicore 9 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.