api/README.md

[![Build Status](https://travis-ci.org/pelias/api.png?branch=master)](https://travis-ci.org/pelias/api)

# API
[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/pelias/api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

## Documentation

See our [API Documentation](https://github.com/pelias/api/blob/master/public/apiDoc.md).

## Install Dependencies

```bash
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](https://github.com/expressjs/morgan#predefined-formats) 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.
Shotgun edits to the README. README.md -Edit a bunch of unrelated things... sorry. ;) -Condense the documentation of different `npm run`nable commands to one list. -Remove the note about Travis, since that applies to virtually all the Pelias repos and is documented elsewhere. -Point the API docs hyperlink to `DOCS.md`. 10 years ago			`[![Build Status](https://travis-ci.org/pelias/api.png?branch=master)](https://travis-ci.org/pelias/api)`

readme 10 years ago			`# API`
Added Gitter badge 10 years ago			`[![Gitter](https://badges.gitter.im/Join Chat.svg)](https://gitter.im/pelias/api?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)`
readme 10 years ago
readme 10 years ago			`## Documentation`

Fix broken link to DOCS 9 years ago			`See our [API Documentation](https://github.com/pelias/api/blob/master/public/apiDoc.md).`
readme 10 years ago
readme 10 years ago			`## Install Dependencies`

			```bash
Shotgun edits to the README. README.md -Edit a bunch of unrelated things... sorry. ;) -Condense the documentation of different `npm run`nable commands to one list. -Remove the note about Travis, since that applies to virtually all the Pelias repos and is documented elsewhere. -Point the API docs hyperlink to `DOCS.md`. 10 years ago			`npm install`
readme 10 years ago			```

Shotgun edits to the README. README.md -Edit a bunch of unrelated things... sorry. ;) -Condense the documentation of different `npm run`nable commands to one list. -Remove the note about Travis, since that applies to virtually all the Pelias repos and is documented elsewhere. -Point the API docs hyperlink to `DOCS.md`. 10 years ago			`## scripts`
add to README 10 years ago
Shotgun edits to the README. README.md -Edit a bunch of unrelated things... sorry. ;) -Condense the documentation of different `npm run`nable commands to one list. -Remove the note about Travis, since that applies to virtually all the Pelias repos and is documented elsewhere. -Point the API docs hyperlink to `DOCS.md`. 10 years ago			The API ships with several convenience commands (runnable via `npm`):
add to README 10 years ago
Shotgun edits to the README. README.md -Edit a bunch of unrelated things... sorry. ;) -Condense the documentation of different `npm run`nable commands to one list. -Remove the note about Travis, since that applies to virtually all the Pelias repos and is documented elsewhere. -Point the API docs hyperlink to `DOCS.md`. 10 years ago			* `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
readme 10 years ago
Document the pelias-config accessLog option. README.md -Add a section documenting all of the pelias-config options recognized by the API. -Document the `accessLog` option. 10 years ago			`## 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](https://github.com/expressjs/morgan#predefined-formats) in the `morgan` package. Defaults to
			`"common"`; if set to `false`, or an otherwise falsy value, disables access-logging entirely.

Shotgun edits to the README. README.md -Edit a bunch of unrelated things... sorry. ;) -Condense the documentation of different `npm run`nable commands to one list. -Remove the note about Travis, since that applies to virtually all the Pelias repos and is documented elsewhere. -Point the API docs hyperlink to `DOCS.md`. 10 years ago			`## Contributing`
readme 10 years ago
Shotgun edits to the README. README.md -Edit a bunch of unrelated things... sorry. ;) -Condense the documentation of different `npm run`nable commands to one list. -Remove the note about Travis, since that applies to virtually all the Pelias repos and is documented elsewhere. -Point the API docs hyperlink to `DOCS.md`. 10 years ago			`Please fork and pull request against upstream master on a feature branch. Pretty please; provide unit tests and script`
			fixtures in the `test` directory.