schmidtk / koop

:crystal_ball: Transform, query, and download geospatial data on the web.

Koop

Translate, query, & integrate any geospatial API on the web

Koop is a JavaScript toolkit for making requests to spatial APIs. It exposes a Node.js web server that faciliates on-the-fly transformations of geospatial data from one format to another and delivers it to clients by HTTP. Koop allows you to keep your data in its native format, while making it accessible in any format required. Out-of-the-box, Koop can translates your data into the GeoServices specification supported by ArcGIS products. It's plugin architecture supports output in other formats including vector-tile, WMS, and plain old GeoJSON. Learn more at https://koopjs.github.io.

Koop's plugin-architecture facilate custom deployments specific to your needs. "Provider" plugins to connect to novel data formats and translate to a common format (GeoJSON), while "output" plugins then transform that GeoJSON to other specifications. See a list of plugins already authored and maintained here. If you have a novel datasource or require an as-yet unsupported output format, new plugins can be easily developed and integrated. See the development section of the Koop docs.

Koop Monorepo

This repository is home of the Koop monorepo. In contains a collection of packages that are shipped by default with every Koop instance. koop-core is the parent package and is used to generate a default configuration of Koop. References to the "Koop version" refer to the version of this package. The other packages in this monorepo are dependencies of koop-core and include the Geoservices output-plugin and its dependencies, the default in-memory data cache, and a logger. All other plugins (providers, outputs, etc) are in separate repositories.

The Koop dependency graph is shown below.

Contributing

Pull requests are welcomed and encouraged. Please consider the following PR guidelines:

1. Provide a clear description of what the PR is trying to solve. Link to any existing issues
2. Aim for clear, readable code.
3. Use conventional commit messages. For convenience, you can add commits with npm run commit.
4. Add unit tests and ensure any new code has 100% test coverage. You can do this by running npm run test:cov and then looking for your file in the /coverage/index.html output.
5. Run npm run lint:fix and ensure you're not commiting lint
6. If your new code requires a release, please run npm run changeset:add and commit the generated changeset file as a part of your PR.

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Issues

Find a bug or want to request a new feature? Post it here.

Resources

• Koop Documentation
• ArcGIS REST API Documentation
• ArcGIS for Developers
• @esri

License

Apache 2.0