open-street-map-plugin/README.md
Fedor A. Fetisov c9a742ff83 Switch to OSM service
Rename the plugin and replace proprietary Google Maps service with Open Street Map
2018-05-10 02:11:07 +03:00

37 lines
1.2 KiB
Markdown

# Open Street Map plugin
Based upon the code of [Mibew Google Maps plugin](https://github.com/Mibew/google-maps-plugin).
Displays a visitor's location using Open Street Map service.
## Installation
1. Get the archive with the plugin sources. You can download it from the [official site](https://mibew.org/plugins#mibew-open-street-map) or build the plugin from sources.
2. Untar/unzip the plugin's archive.
3. Put files of the plugins to the `<Mibew root>/plugins` folder.
4. Navigate to "`<Mibew Base URL>`/operator/plugin" page and enable the plugin.
## Plugin's configurations
This plugin does not require any configuration.
## Build from sources
There are several actions one should do before use the latest version of the plugin from the repository:
1. Obtain a copy of the repository using `git clone`, download button, or another way.
2. Install [node.js](http://nodejs.org/) and [npm](https://www.npmjs.org/).
3. Install [Gulp](http://gulpjs.com/).
4. Install npm dependencies using `npm install`.
5. Run Gulp to build the sources using `gulp default`.
Finally `.tar.gz` and `.zip` archives of the ready-to-use Plugin will be available in `release` directory.
## License
[Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0.html)