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.
321 Commits
67 Branches
133 Tags
4.7 MiB
 
 
Tree: e3cdda9778
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e3cdda9778'
${ noResults }
Diana Shkolnikov e3cdda9778
ugh another comment fix 		10 years ago
controller Merge branch 'master' into address-details 10 years ago
docs Documentation and some ciao tests 10 years ago
helper passing in an object (req.clean) instead of a boolean. Plus updated test 10 years ago
middleware Don't report full errors in API results. 10 years ago
query Change query to use `terms` and add code coverage stats 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 fix comments and tests 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 remove code-climate hooks 10 years ago
DOCS.md fix comments and tests 10 years ago
EXAMPLES.md add examples 10 years ago
README.md add to 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 Change query to use `terms` and add code coverage stats 10 years ago

README.md

API

![Gitter](https://badges.gitter.im/Join Chat.svg)

Pelias RESTful API

Documentation

API Documentation

Install Dependencies

The API uses scripts for scoring/sorting that needs to be installed.

You must install the pelias scripts from: https://github.com/pelias/scripts.

Failing 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

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.

Start Server

$ npm start

Running Unit Tests

$ npm run unit

Running Functional Tests

(this requires the server to be running)

$ npm run ciao

Running All Tests

$ npm test

Generate API Documentation

$ npm run docs

Code Coverage

$ npm run coverage

Continuous Integration

Travis tests every release against node version 0.10

Build Status