search

vinayakkulkarni / v-mapbox

Vue-ish way for interacting with map(box|libre)-gl-js 🧭
https://v-mapbox.netlify.app/
MIT License
187 stars 45 forks source link
mapbox-gl-js maplibre maplibre-gl maplibre-gl-js v-mapbox vue vue3

readme

V-Mapbox 🗺

npm

GitHub release (latest by date including pre-releases)

Total alerts

DeepScan grade

npm

GitHub last commit

GitHub contributors

Maintenance

Combine powers of Vue and Mapbox GL JS (v3.x) & MaplibreGL (v4.x) 🗺

V-Mapbox is wrapper around Mapbox GL JS for >v1.x to <=v3.x & Maplibre GL JS for > v4.x library that provides vueish-way to interact with the map.

Description and documentation

Installation

# For Vue 2
$ npm i v-mapbox@legacy
# For Vue 3
$ npm i v-mapbox

Demo

Edit v-mapbox-vue-3

Deck.gl 🆕

Edit v-mapbox-with-deck-gl-geojson

Development

git clone git@github.com:vinayakkulkarni/v-mapbox.git
cd v-mapbox
npm install

Running in dev mode:

npm run serve

Build for production:

npm run build

Documentation

Start documentation site in development mode:

npm run docs:dev

Build documentation:

npm run docs:build

Inspired by KoRiGaN's Vue2Leaflet.

Contributing

  1. Fork it (https://github.com/vinayakkulkarni/v-mapbox/fork)
  2. Create your feature branch (git checkout -b feat/new-feature)
  3. Commit your changes (git commit -Sam 'feat: add feature')
  4. Push to the branch (git push origin feat/new-feature)
  5. Create a new Pull Request

Note:

  1. Please contribute using GitHub Flow
  2. Commits & PRs will be allowed only if the commit messages & PR titles follow the conventional commit standard, read more about it here
  3. PS. Ensure your commits are signed. Read why

Author

v-mapbox © Vinayak, Released under the MIT License.
Authored and maintained by Vinayak Kulkarni with help from contributors (list).

vinayakkulkarni.dev · GitHub @vinayakkulkarni · Twitter @_vinayak_k

License

MIT

FOSSA Status