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.
713 Commits
67 Branches
133 Tags
4.7 MiB
 
 
Tree: 62315a1775
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '62315a1775'
${ noResults }
Diana Shkolnikov 62315a1775
Revert defaults.json change 		9 years ago
controller more conformance 9 years ago
docs Use text param in docs containing successful queries 9 years ago
helper Remove admin matching when address is not parsed 9 years ago
middleware Remove admin matching when address is not parsed 9 years ago
public Merge remote-tracking branch 'origin/master' into private-param-235 9 years ago
query Revert defaults.json change 9 years ago
routes Remove admin matching when address is not parsed 9 years ago
sanitiser Remove admin matching when address is not parsed 9 years ago
service Confidence score calculation 9 years ago
src Replace src/logger with pelias-logger. 10 years ago
test Revert defaults.json change 9 years ago
.gitignore Add pids directory to gitignore 9 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 change dependency to git url until PR merged upstream, test travis against 0.10,0.12 10 years ago
EXAMPLES.md add examples 10 years ago
README.md Fix broken link to DOCS 9 years ago
app.js fix CORS support by enabling OPTIONS endpoint 9 years ago
index.js run webserver on all available cores, resolves #6 10 years ago
package.json Lock down the pelias-query version 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.