https://github.com/gavinr/koop-provider-gbfs-bikeshare

A provider for koop to show bikeshare locations
https://github.com/gavinr/koop-provider-gbfs-bikeshare

koop koop-provider koopjs

Last synced: 13 days ago
JSON representation

A provider for koop to show bikeshare locations

• Host: GitHub
• URL: https://github.com/gavinr/koop-provider-gbfs-bikeshare
• Owner: gavinr
• License: apache-2.0
• Created: 2019-07-09T06:24:58.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-07-10T04:17:08.000Z (over 5 years ago)
• Last Synced: 2024-10-19T23:22:31.451Z (24 days ago)
• Topics: koop, koop-provider, koopjs
• Language: JavaScript
• Size: 150 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

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

# Koop Provider GBFS Bikeshare

Exposes locations of bikeshare bicycles that conform to the [GBFS](https://github.com/NABSA/gbfs).

## Getting started

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

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

3. Open `model.js` and implement `getData` to call your provider and return GeoJSON

4. Install dependencies `npm install`

5. Run a local server `npm start`

6. Add tests to `test/`

## Koop provider file structure

| File | | Description |

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

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

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

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

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

| `server.js` | Optional | Reference implementation for the provider |

| `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/sample/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`

## Deploy to AWS Lambda

Koop providers can be quickly deployed and scaled with AWS Lambda. To first create the service:

- `npm run lambda-create`

To deploy code updates

- `npm run lambda-update`

### AWS Lambda configuration

By default, AWS Lambda has a 3 second timeout and only 128MB memory. If your Koop provider uses a slower service, then you should change the AWS Lambda timeout to a higher time limit (e.g. 60 seconds) as well as add more memory (e.g. 512MB).

## With Docker

- `docker build -t koop-provider-sample .`

- `docker run -it -p 8080:8080 koop-provider-sample`

## Publish to npm

- run `npm init` and update the fields

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

- run `npm publish`