Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/soal/vue-mapbox

Vuejs 2 components for interacting with mapbox-gl-js
https://github.com/soal/vue-mapbox

mapbox mapbox-gj-js mapbox-gl vue vue-mapbox vue2 vuejs

Last synced: about 1 month ago
JSON representation

Vuejs 2 components for interacting with mapbox-gl-js

Awesome Lists containing this project

README

        

# VueMapbox [![Build Status](https://travis-ci.org/soal/vue-mapbox.svg?branch=master)](https://travis-ci.org/soal/vue-mapbox) [![npm version](https://badge.fury.io/js/vue-mapbox.svg)](https://badge.fury.io/js/vue-mapbox)

> Combine powers of [Vue.js](https://vuejs.org/) and [Mapbox Gl JS](https://mapbox.com/mapbox-gl-js)

Vue-mapbox is wrapper around Mapbox GL JS library that provides vueish-way to interact with the map.

[Description and documentation](https://soal.github.io/vue-mapbox)

## Size

~ 15 kB minified and gzipped

## Browser compatibility

_Coming soon_

## Development

```sh
git clone [email protected]:soal/vue-mapbox.git
cd vue-mapbox
npm install
```

Running in dev mode:

```sh
npm run serve
```

Build for production:

```sh
npm run build
```

### Documentation

Documentation use [VuePress 1.0](https://vuepress.vuejs.org).
Documentations source palced in `docs_source` directory and builds into `docs` directory

Start documentation site in development mode:

```sh
npm run docs:serve
```

Build documentation:

```sh
npm run docs:build
```

Inspired by KoRiGaN's [Vue2Leaflet](https://github.com/KoRiGaN/Vue2Leaflet).

## License

MIT

## Contributing

Just fork `development` branch and create PR when your work is done. Please ensure you are not added dist files.