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.
997 Commits
67 Branches
133 Tags
4.7 MiB
 
 
Tree: a2e96987fc
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'a2e96987fc'
${ noResults }
Vesa Meskanen a2e96987fc
Remove expensive JSON.stringify from api debug logging calls 		9 years ago
bin Check pelias server is running before generating docs 9 years ago
controller Remove expensive JSON.stringify from api debug logging calls 9 years ago
helper Get rid of QS references 9 years ago
middleware Cleanup renamePlacenames 9 years ago
public Add link to WOF license file 9 years ago
query Remove all usage of alpha3/admin0/admin1, update query building to reflect new names in pelias-query 9 years ago
routes Use clean.layers to determine types 9 years ago
sanitiser Add sources and layers sanitiser 9 years ago
service Filter source and layer by new fields 9 years ago
src Use the official elasticsearch 9 years ago
test Merge pull request #438 from pelias/test_utils 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 Fix test suite name 9 years ago
Dockerfile add default config 9 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 9 years ago
package.json Use the official elasticsearch 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.