open-index/open-npm huggingface dataset:
npm package: @maksudcs/flowmap.gl
Description: Flow map drawing layer for Deck.gl
Author: Ilya Boyandin
Latest version: 1.0.0

# Flowmap.gl

<a href=https://visgl.github.io/flowmap.gl/><img alt=flowmap-gl src=https://user-images.githubusercontent.com/351828/147912794-36eab3ce-7ce3-40d6-ad24-4a11c1bda924.jpg width=400></a>

[Flow map](https://en.wikipedia.org/wiki/Flow_map) drawing layer for [deck.gl](http://deck.gl). Can be used for visualizing movement of people (e.g. migration) or objects between geographic locations. The layer is rendered in WebGL and can handle large numbers of flows with a relatively good rendering performance.

Try [FlowmapBlue](https://flowmap.blue/) and [Flowmap City](https://flowmap.city/) for an easy way of publishing flow maps (no programming skills required).

Run the [LIVE EXAMPLE](https://visgl.github.io/flowmap.gl/) or
check the source code of the following examples:

- [Minimal Pure js example](https://github.com/ilyabo/flowmap.gl-purejs-example)

  [![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/github/ilyabo/flowmap.gl-purejs-example?file=main.js)

- [React example](./examples/react-app)
- [React worker example](./examples/react-worker-app)
- [Svelte example](./examples/svelte-app)

## Development

Building flowmap.gl locally from the source requires Node.js.
We use [yarn](https://yarnpkg.com/en/docs/install) to manage the dependencies.

```bash
# Install dependencies
yarn

# Add your Mapbox token to .env (needed for background map)
cd examples/react-app
cp .env.example .env

# Start example app in dev mode
cd ../..
yarn start
```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz_small.svg)](https://stackblitz.com/github/visgl/flowmap.gl?file=examples%2Freact-app%2Fsrc%2FApp.tsx)

## Contributing to flowmap.gl

Thanks for taking the time to contribute!

PRs and bug reports are welcome.
Please be mindful of and adhere to the Contributor Covenant's [Code of Conduct](CODE_OF_CONDUCT.md) when contributing to flowmap.gl. Also, check out [vis.gl developer process](https://www.github.com/visgl/tsc/tree/master/developer-process).

## Maintainers

- [Ilya Boyandin](https://github.com/ilyabo) – ilya@boyandin.me

## License

    Copyright (c) Flowmap.gl contributors
    Copyright (c) 2018-2020 Teralytics
    SPDX-License-Identifier: Apache-2.0

[Full-text license](LICENSE)

## Acknowledgements

The project was [originally developed at Teralytics](https://github.com/teralytics/flowmap.gl). Thanks to [Philippe Voinov](https://github.com/tehwalris) for his help with the first version of `FlowLinesLayer`, to [Nikita Rokotyan](https://github.com/rokotyan) for his advice on implementing `AnimatedFlowLinesLayer` and to [Xiaoji Chen](https://github.com/pessimistress) for her help with [deck.gl](http://deck.gl).