v-mapbox
v5.1.0
Published
Maplibre (and Mapbox) with Vue ๐
Downloads
3,950
Maintainers
Readme
V-Mapbox ๐บ
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.
Installation
# For Vue 2
$ npm i v-mapbox@legacy
# For Vue 3
$ npm i v-mapbox
Demo
Deck.gl ๐
Development
git clone [email protected]: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
- Fork it (https://github.com/vinayakkulkarni/v-mapbox/fork)
- Create your feature branch (
git checkout -b feat/new-feature
) - Commit your changes (
git commit -Sam 'feat: add feature'
) - Push to the branch (
git push origin feat/new-feature
) - Create a new Pull Request
Note:
- Please contribute using GitHub Flow
- Commits & PRs will be allowed only if the commit messages & PR titles follow the conventional commit standard, read more about it here
- 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