https://github.com/koopjs/koop-provider-socrata
Koop 3.0 provider plugin for Socrata
https://github.com/koopjs/koop-provider-socrata
koop opendata plugin provider socrata-api
Last synced: over 1 year ago
JSON representation
Koop 3.0 provider plugin for Socrata
- Host: GitHub
- URL: https://github.com/koopjs/koop-provider-socrata
- Owner: koopjs
- Created: 2019-12-09T20:39:04.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-09T21:49:26.000Z (over 3 years ago)
- Last Synced: 2025-01-24T10:47:17.443Z (over 1 year ago)
- Topics: koop, opendata, plugin, provider, socrata-api
- Language: JavaScript
- Homepage:
- Size: 10.7 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# @koopjs/provider-socrata
[](https://www.npmjs.com/package/@koopjs/provider-socrata) [](https://www.travis-ci.org/koopjs/koop-provider-socrata)
A minimal Koop 3.x provider for connecting to Socrata data sources.
## Installation
``` bash
npm install @koopjs/provider-socrata
```
## Accessing Socrata data
Use the Koop `host` and `id` parameter to dynamically point your provider to a Socrata resource.
For example, to access the data at [https://data.ct.gov/resource/y6p2-px98.json](https://data.ct.gov/resource/y6p2-px98.json) you would use a `host` value of `data.ct.gov` and an `id` value of `y6p2-px98`. This would translate to the following Koop FeatureServer endpoint:
[http://localhost:8080/koop-provider-socrata/data.ct.gov/y6p2-px98/FeatureServer/0/query](http://localhost:8080/koop-provider-socrata/data.ct.gov/y6p2-px98/FeatureServer/0/query)
## Testing
This project uses [mocha](https://www.npmjs.com/package/mocha) as the testing framework and [chaijs](https://www.chaijs.com/) as the assertion library. All test files in the `test` directory should have the special extension `.test.js`, which will be executed by the command:
```
$ npm test
```
## Dev Server
This project by default uses the [Koop CLI](https://github.com/koopjs/koop-cli) to set up the dev server. It can be invoded via
```
$ npm start
```
The server will be running at `http://localhost:8080` or at the port specified at the configuration.
Check your instance with this test endpoint:
[http://localhost:8080/koop-provider-socrata/data.ct.gov/y6p2-px98/FeatureServer/0/query](http://localhost:8080/koop-provider-socrata/data.ct.gov/y6p2-px98/FeatureServer/0/query)