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.
349 Commits
67 Branches
133 Tags
4.7 MiB
 
 
Tree: 56922a012a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '56922a012a'
${ noResults }
Severyn Kozak 56922a012a
Merge pull request #126 from pelias/edit-docs 		10 years ago
controller Merge branch 'master' into address-details 10 years ago
docs Documentation and some ciao tests 10 years ago
helper Merge pull request #124 from pelias/issue84 10 years ago
middleware Return error message if string. 10 years ago
query Quote properties. 10 years ago
sanitiser ugh another comment fix 10 years ago
service cleanup + tests 10 years ago
src refactor/ add more tests 10 years ago
test Merge pull request #113 from pelias/boost-exact-matches#5 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 drop node 11 from travis 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 Shotgun edits to the README. 10 years ago
app.js using coarse sanitizer for the coarse endpoint 10 years ago
index.js fixing all the js lint related issues (lintified) 10 years ago
package.json package.json: v1.2.1 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

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.