mapkit-vue

A Vue library for Apple Mapkit

This project is under active development and is not yet ready for production

Table of Contents

• Installation
• Usage
• Documentation
• Development
• License

Installation

npm install -S mapkit-vue

Usage

Please follow the official MapkitJS documentation to setup your API credentials.

import Vue from 'vue';
import MapkitVue from 'mapkit-vue';

Vue.use(MapkitVue, {
  authorizationCallback (done) {
    done('your-jwt-here')
  }
});

Documentation

Make sure all dependencies are installed:

npm install

To run a documentation dev server:

npm run docs:dev

To build documentation:

npm run docs:build

To publish documentation to gh-pages:

npm run docs:publish

Development

A sandboxed dev environment is provided by vue-play. Changes made to the component files will appear in real time in the sandbox.

To begin development, run:

npm install
npm run dev

then navigate to http://localhost:5000

To modify and add sandbox scenarios, edit play/index.js

License

This project is licensed under the MIT License - see the LICENSE.md file for details.