![turf](https://raw.githubusercontent.com/Turfjs/turf/9a1d5e8d99564d4080f1e2bf1517ed41d18012fa/logo.png) ====== [![GitHub Actions Status](https://github.com/Turfjs/turf/actions/workflows/ci.yml/badge.svg)](https://github.com/Turfjs/turf/actions/workflows/ci.yml/badge.svg) [![Version Badge][npm-img]][npm-url] [![Gitter chat][gitter-img]][gitter-url] [![Backers on Open Collective][oc-backer-badge]](#backers) [![Sponsors on Open Collective][oc-sponsor-badge]](#sponsors) [![Coverage Status](https://coveralls.io/repos/github/Turfjs/turf/badge.svg)](https://coveralls.io/github/Turfjs/turf) [npm-img]: https://img.shields.io/npm/v/@turf/turf.svg [npm-url]: https://www.npmjs.com/package/@turf/turf [gitter-img]: https://badges.gitter.im/Turfjs/turf.svg [gitter-url]: https://gitter.im/Turfjs/turf [oc-backer-badge]: https://opencollective.com/turf/backers/badge.svg [oc-sponsor-badge]: https://opencollective.com/turf/sponsors/badge.svg ***A modular geospatial engine written in JavaScript*** [Turf](https://turfjs.org) is a [JavaScript library](https://en.wikipedia.org/wiki/JavaScript_library) for [spatial analysis](https://en.wikipedia.org/wiki/Spatial_analysis). It includes traditional spatial operations, helper functions for creating [GeoJSON](https://geojson.org) data, and data classification and statistics tools. Turf can be added to your website as a client-side module, or you can [run Turf server-side](https://www.npmjs.com/package/@turf/turf) with [Node.js](https://nodejs.org/) (see below). ## Getting Started Read our [getting started guide](https://turfjs.org/docs/getting-started) to begin working with Turf. Or explore the Turf API and examples at [turfjs.org](https://turfjs.org/). ## Runtime support Turf is currently published to work with any reasonably modern Javascript runtime. Node is a first class citizen, and we recommend using an [Active or Maintenance LTS](https://nodejs.org/en/about/previous-releases) release. Other runtimes, such as Deno or Bun, are not officially supported. We would be very interested to hear your experiences though. When bundling Turf for the browser, ensure your build setup transpiles and polyfills Turf along with all of its transitive dependencies to match your target browsers. ## Browser support @turf/turf includes a browser bundle that combines, transpiles, and minifies all Turf modules into a single JavaScript file. We periodically update our minimum browser targets using Browserslist's default preset. ## Contributors This project exists thanks to all the people who contribute. If you are interested in helping, check out the [Contributing Guide](docs/CONTRIBUTING.md). ## Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/turf#backer)] ## Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/turf#sponsor)]