# Maps-Widget

[![Build Status](http://build.services.siag.it/view/GIS/job/maps/job/maps-widget/badge/icon)](http://build.services.siag.it/view/GIS/job/maps/job/maps-webclient-build-and-deploy/)

The Maps-Widget is a JavaScript based Single Page Application (SPA) which uses web-components (specifically the library [lit](https://lit.dev/) to simplify the implementation).

## Workstation setup

Required software to be installed

- node + npm (v10.13.0 or newer) [http://nodejs.org/](http://nodejs.org/)

## Develop

First of all, install all required dependencies

```
$ npm install
```

## Test

To run the tests call

```
$ npm run test
```

## Build

The widget can be built as follows

```
$ npm install
$ npm run fix-memory-limit
$ npm run widget-build
```

These commands update the repository libraries and create a "dist" folder that contains the deployable assets.  
  
To create a new release call the script `release.sh` and follow the instructions.  

# Docs

Please consult the [docs for more details](docs/index.md).  
A changelog can be found in [CHANGELOG.md](CHANGELOG.md).

## Widget Demos

You can serve the examples also from the local file-sytem via browser-sync.
Browser-sync is included in the dev-dependencies of package.json. So if you have installed the dependencies (npm i) 
you can launche the examples: 

    $ npm run examples

Note: the examples use the last released version of the maps-widget (not the tip of the master branch).
~~Check this site for a online demo: https://demo-mapswidget.egov.bz.it/~~  

More information is provided in the [examples guide](examples/README.md)


# License

Maps-Widget is published under the LGPL v3 license. For details check out the [LICENSE.TXT](https://git.services.siag.it/gis-sdi/maps/blob/master/LICENSE.TXT).

# Contribute

Want to contribute? Great, [check out our contribution guidelines](CONTRIBUTING.md).  
Found a bug? Please let us know, [email us](mailto:maps-opensource@siag.it)