mirror of https://github.com/pelias/api.git
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.
Severyn Kozak
d0dd39257b
|
10 years ago | |
|---|---|---|
| controller | 10 years ago | |
| docs | 10 years ago | |
| helper | 10 years ago | |
| middleware | 10 years ago | |
| query | 10 years ago | |
| sanitiser | 10 years ago | |
| service | 10 years ago | |
| src | 10 years ago | |
| test | 10 years ago | |
| .gitignore | 10 years ago | |
| .jshintignore | 10 years ago | |
| .jshintrc | 10 years ago | |
| .travis.yml | 10 years ago | |
| DOCS.md | 10 years ago | |
| EXAMPLES.md | 10 years ago | |
| README.md | 10 years ago | |
| app.js | 10 years ago | |
| index.js | 10 years ago | |
| package.json | 10 years ago | |
README.md
API
Pelias RESTful 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
