README.md 1.92 KB
Newer Older
MAgethle's avatar
MAgethle committed
1
# Maps-Widget
2

MAgethle's avatar
MAgethle committed
3
[![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/)
4

MAgethle's avatar
MAgethle committed
5
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).
6

MAgethle's avatar
MAgethle committed
7
## Workstation setup
8 9 10

Required software to be installed

MAgethle's avatar
MAgethle committed
11
- node + npm (v10.13.0 or newer) [http://nodejs.org/](http://nodejs.org/)
12

MAgethle's avatar
MAgethle committed
13
## Develop
14

Juri's avatar
Juri committed
15
First of all, install all required dependencies
16 17 18

```
$ npm install
Juri's avatar
Juri committed
19 20
```

MAgethle's avatar
MAgethle committed
21
## Test
Juri's avatar
Juri committed
22

MAgethle's avatar
MAgethle committed
23
To run the tests call
Juri's avatar
Juri committed
24 25

```
MAgethle's avatar
MAgethle committed
26
$ npm run test
Juri's avatar
Juri committed
27 28 29 30
```

## Build

MAgethle's avatar
MAgethle committed
31
The widget can be built as follows
Juri's avatar
Juri committed
32 33

```
TAuckenthal's avatar
TAuckenthal committed
34 35
$ npm install
$ npm run fix-memory-limit
MAgethle's avatar
MAgethle committed
36
$ npm run widget-build
37 38
```

MAgethle's avatar
MAgethle committed
39 40 41
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.  
42

MAgethle's avatar
MAgethle committed
43 44
# Docs

MAgethle's avatar
MAgethle committed
45 46
Please consult the [docs for more details](docs/index.md).  
A changelog can be found in [CHANGELOG.md](CHANGELOG.md).
MAgethle's avatar
MAgethle committed
47

MAgethle's avatar
MAgethle committed
48
## Widget Demos
MAgethle's avatar
MAgethle committed
49 50 51 52 53 54 55

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

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

MAgethle's avatar
MAgethle committed
59
More information is provided in the [examples guide](examples/README.md)
MAgethle's avatar
MAgethle committed
60

61

SPutzer's avatar
SPutzer committed
62
# License
63

MAgethle's avatar
MAgethle committed
64
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).
65

MAgethle's avatar
MAgethle committed
66
# Contribute
67

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