You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+51-15Lines changed: 51 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,28 @@ Vaadin 14+ addon for Google Maps Web Component
18
18
19
19
[Available in Vaadin Directory](https://vaadin.com/directory/component/google-maps-addon)
20
20
21
+
### Maven install
22
+
23
+
Add the following dependencies in your pom.xml file:
24
+
25
+
```xml
26
+
<dependency>
27
+
<groupId>com.flowingcode.vaadin.addons</groupId>
28
+
<artifactId>google-maps</artifactId>
29
+
<version>X.Y.Z</version>
30
+
</dependency>
31
+
```
32
+
<!-- the above dependency should be updated with latest released version information -->
33
+
34
+
```xml
35
+
<repository>
36
+
<id>vaadin-addons</id>
37
+
<url>https://maven.vaadin.com/vaadin-addons</url>
38
+
</repository>
39
+
```
40
+
41
+
For SNAPSHOT versions see [here](https://maven.flowingcode.com/snapshots/).
42
+
21
43
## Building and running demo
22
44
23
45
- git clone repository
@@ -35,14 +57,18 @@ The issues for this add-on are tracked on its github.com page. All bug reports a
35
57
36
58
## Contributions
37
59
38
-
Contributions are welcome, but there are no guarantees that they are accepted as such. Process for contributing is the following:
60
+
Contributions are welcome, but there are no guarantees that they are accepted as such.
39
61
40
-
- Fork this project
62
+
As first step, please refer to our [Development Conventions](https://github.com/FlowingCode/DevelopmentConventions) page to find information about Conventional Commits & Code Style requeriments.
63
+
64
+
Then, follow these steps for creating a contibution:
65
+
66
+
- Fork this project.
41
67
- Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
42
68
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
43
-
-Refer to the fixed issue in commit
44
-
- Send a pull request for the original project
45
-
- Comment on the original issue that you have implemented a fix for it
69
+
-For commit message, use [Conventional Commits](https://github.com/FlowingCode/DevelopmentConventions/blob/main/conventional-commits.md) to describe your change.
70
+
- Send a pull request for the original project.
71
+
- Comment on the original issue that you have implemented a fix for it.
46
72
47
73
## License & Author
48
74
@@ -55,14 +81,24 @@ GoogleMapsAddon is written by Flowing Code S.A.
55
81
## Getting started
56
82
57
83
Create an instance of GoogleMap, configure it, add markers, polygons, etc:
By default, Vaadin Flow only includes ```com/vaadin/flow/component``` to be always scanned for UI components and views. For this reason, the addon might need to be whitelisted in order to display correctly.
99
+
100
+
To do so, just add ```com.flowingcode``` to the ```vaadin.whitelisted-packages``` property in ```src/main/resources/application.properties```, like:
More information on Spring whitelisted configuration [here](https://vaadin.com/docs/latest/integrations/spring/configuration/#configure-the-scanning-of-packages).
0 commit comments