https://github.com/koopjs/koop-provider-example

Sample provider for Koop.
https://github.com/koopjs/koop-provider-example

koop-provider

Last synced: 3 months ago
JSON representation

Sample provider for Koop.

• Host: GitHub
• URL: https://github.com/koopjs/koop-provider-example
• Owner: koopjs
• License: other
• Created: 2014-04-29T20:12:31.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T12:29:39.000Z (over 1 year ago)
• Last Synced: 2024-07-05T16:34:03.315Z (4 months ago)
• Topics: koop-provider
• Language: JavaScript
• Homepage:
• Size: 628 KB
• Stars: 22
• Watchers: 15
• Forks: 27
• Open Issues: 11
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Koop Provider Example

[![Build Status](https://travis-ci.org/koopjs/koop-provider-example.svg?branch=master)](https://travis-ci.org/koopjs/koop-provider-example) [![Greenkeeper badge](https://badges.greenkeeper.io/koopjs/koop-provider-example.svg)](https://greenkeeper.io/)

This is an example that demonstrates how to build a Koop Provider. You can clone this project, and use it to start a new provider. This sample can run a local server, deploy to AWS Lambda or Docker for testing and operations. Once the provider is published to NPM, then it can be used with other Koop providers and outputs in a larger project.

The data source in this example is the [TriMet Bus API](https://developer.trimet.org). You can see this provider in action [here](http://dcdev.maps.arcgis.com/home/item.html?id=2603e7e3f10742f78093edf8ea2adfd8#visualize).

Full documentation is provided [here](https://koopjs.github.io/docs/usage/provider).

## Getting started

1. Open `config/default.json` with any configurable parameters

1. Open `src/index.js` and change `provider.name` to a unique name

1. Open `src/model.js` and implement `getData` to call your provider and return GeoJSON

1. Install dependencies `npm install`

1. Run a local dev server `npm start`

1. Add tests to `test/`

## Koop provider file structure

| File | | Description |

| --- | --- | --- |

| `src/index.js` | Mandatory | Configures provider for usage by Koop |

| `src/model.js` | Mandatory | Translates remote API to GeoJSON |

| `src/routes.js` | Optional | Specifies additional routes to be handled by this provider |

| `src/controller.js` | Optional | Handles additional routes specified in `routes.js` |

| `test/model-test.js` | Optional | tests the `getData` function on the model |

| `test/fixtures/input.json` | Optional | a sample of the raw input from the 3rd party API |

| `config/default.json` | Optional | used for advanced configuration, usually API keys. |

## Test it out

Run server:

- `npm install`

- `npm start`

Example API Query:

- `curl localhost:8080/example/FeatureServer/0/query?returnCountOnly=true`

Tests:

- `npm test`

### Development output callstack logs

During development you can output error callstack with

- `NODE_ENV=test npm start`

## Publish to npm

- run `npm init` and update the fields

  - Choose a name like `koop-provider-foo`

- run `npm publish`