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.
913 Commits
67 Branches
133 Tags
4.7 MiB
 
 
Tree: 0f121c5ffe
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '0f121c5ffe'
${ noResults }
Julian Simioni 0f121c5ffe
Move doc generation commands to script file 		9 years ago
bin Move doc generation commands to script file 9 years ago
controller Add simple normalizer (lowercase + remove punctuation) 9 years ago
helper calcSize became middleware (exposed and fixed bug in query defaults) 9 years ago
middleware Merge branch 'master' into autocomplete_config_tweaks 9 years ago
public Add link to GitHub documentation on /v1/ "landing page" 9 years ago
query simplify pass 3 9 years ago
routes calcSize became middleware (exposed and fixed bug in query defaults) 9 years ago
sanitiser one config per query 9 years ago
service remove microtime module 9 years ago
src Replace src/logger with pelias-logger. 10 years ago
test Fix failing Ciao tests 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
Dockerfile add default config 9 years ago
EXAMPLES.md add examples 10 years ago
README.md installing pelias/scripts no longer required 9 years ago
app.js http friendly status codes. resolves #321 9 years ago
circle.yml fix circle deployments 9 years ago
index.js run webserver on all available cores, resolves #6 10 years ago
package.json Move doc generation commands to script file 9 years ago
pelias.json.docker add default config 9 years ago

README.md

Build Status

API

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

Documentation

See our API Documentation.

Install Dependencies

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.