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.
Julian Simioni
df40e34ad5
|
9 years ago | |
---|---|---|
controller | 9 years ago | |
docs | 9 years ago | |
helper | 9 years ago | |
middleware | 9 years ago | |
public | 9 years ago | |
query | 9 years ago | |
routes | 9 years ago | |
sanitiser | 9 years ago | |
service | 9 years ago | |
src | 10 years ago | |
test | 9 years ago | |
.gitignore | 9 years ago | |
.jshintignore | 10 years ago | |
.jshintrc | 10 years ago | |
.travis.yml | 10 years ago | |
EXAMPLES.md | 10 years ago | |
README.md | 10 years ago | |
app.js | 9 years ago | |
index.js | 10 years ago | |
package.json | 9 years ago |
README.md
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 servernpm test
: run unit testsnpm run ciao
: run functional tests (this requires that the server be running)npm run docs
: generate API documentationnpm 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 themorgan
package. Defaults to"common"
; if set tofalse
, 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.