Skip to content
Bryan Housel edited this page Apr 26, 2021 · 6 revisions

File List

The files under dist/* are generated:

  • resources.json - A JSON object containing only the community resources
  • featureCollection.json - A GeoJSON FeatureCollection containing only the custom Features
  • completeFeatureCollection.json - A GeoJSON FeatureCollection of all Features, each with available resources included in a resources property.
  • img/* - SVG logos for all the resource types


🧐: "Why use .json instead of .geojson as the file extension for generated GeoJSON files?"
🤓: "So you can require or import them as modules into other JavaScript code if you want."

Each file is available in both regular .json or minified .min.json format.

Metadata

Each JSON file contains a block of metadata like:

"_meta": {
  "version": "4.0.20210425",
  "generated": "2021-04-25T17:29:39.901Z",
  "url": "https://raw.githubusercontent.com/osmlab/osm-community-index/main/dist/resources.json",
  "hash": "b92101cb2f8b4223790b1cf4974f8998"
}
  • version - the semantic version of project when the file was generated: major.minor.patch where patch is the date in yyyymmdd format
  • generated - the date that the file was generated
  • url - source url where the file is available
  • hash - MD5 hash of the file

Home

For Contributors

For Developers

Information for developers using the osm-community-index in another project.

For Maintainers

Information for maintainers, including how to clone and build the project.

 

Clone this wiki locally