Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vinayakkulkarni/v-mapbox
Vue-ish way for interacting with map(box|libre)-gl-js 🧭
https://github.com/vinayakkulkarni/v-mapbox
mapbox-gl-js maplibre maplibre-gl maplibre-gl-js v-mapbox vue vue3
Last synced: 2 days ago
JSON representation
Vue-ish way for interacting with map(box|libre)-gl-js 🧭
- Host: GitHub
- URL: https://github.com/vinayakkulkarni/v-mapbox
- Owner: vinayakkulkarni
- License: mit
- Created: 2020-06-17T12:34:16.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-28T19:25:41.000Z (8 months ago)
- Last Synced: 2024-05-30T05:20:37.976Z (8 months ago)
- Topics: mapbox-gl-js, maplibre, maplibre-gl, maplibre-gl-js, v-mapbox, vue, vue3
- Language: Vue
- Homepage: https://v-mapbox.netlify.app/
- Size: 49.6 MB
- Stars: 181
- Watchers: 7
- Forks: 44
- Open Issues: 42
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# V-Mapbox 🗺
> Combine powers of [Vue](https://vuejs.org/) and [Mapbox GL JS](https://mapbox.com/mapbox-gl-js) (v3.x) & [MaplibreGL](https://maplibre.org/maplibre-gl-js/docs/) (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](https://v-mapbox.netlify.app/)
## Installation
```sh
# For Vue 2
$ npm i v-mapbox@legacy
# For Vue 3
$ npm i v-mapbox
```
## Demo
[](https://codesandbox.io/s/v-mapbox-uq9ri2?fontsize=14&hidenavigation=1&theme=dark)
## Deck.gl 🆕
[](https://codesandbox.io/s/v-mapbox-with-deck-gl-geojson-f8nn5q?fontsize=14&hidenavigation=1&theme=dark)
## Development
```sh
git clone [email protected]:vinayakkulkarni/v-mapbox.git
cd v-mapbox
npm install
```
Running in dev mode:
```sh
npm run serve
```
Build for production:
```sh
npm run build
```
### Documentation
Start documentation site in development mode:
```sh
npm run docs:dev
```
Build documentation:
```sh
npm run docs:build
```
Inspired by KoRiGaN's [Vue2Leaflet](https://github.com/KoRiGaN/Vue2Leaflet).
## Contributing
1. Fork it ([https://github.com/vinayakkulkarni/v-mapbox/fork](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](https://github.com/vinayakkulkarni/v-mapbox/compare)
_Note_:
1. Please contribute using [GitHub Flow](https://web.archive.org/web/20191104103724/https://guides.github.com/introduction/flow/)
2. Commits & PRs will be allowed only if the commit messages & PR titles follow the [conventional commit standard](https://www.conventionalcommits.org/), _read more about it [here](https://github.com/conventional-changelog/commitlint/tree/master/%40commitlint/config-conventional#type-enum)_
3. PS. Ensure your commits are signed. _[Read why](https://withblue.ink/2020/05/17/how-and-why-to-sign-git-commits.html)_
## Author
**v-mapbox** © [Vinayak](https://github.com/vinayakkulkarni), Released under the [MIT](./LICENSE) License.
Authored and maintained by Vinayak Kulkarni with help from contributors ([list](https://github.com/vinayakkulkarni/v-mapbox/contributors)).
> [vinayakkulkarni.dev](https://vinayakkulkarni.dev) · GitHub [@vinayakkulkarni](https://github.com/vinayakkulkarni) · Twitter [@\_vinayak_k](https://twitter.com/_vinayak_k)
## License
MIT
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fvinayakkulkarni%2Fv-mapbox?ref=badge_large)