Skip to content

Commit 9a0a699

Browse files
mlopezFCmlopezFC
authored
Initial commit
0 parents  commit 9a0a699

File tree

19 files changed

+1285
-0
lines changed

19 files changed

+1285
-0
lines changed

‎.gitignore‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
node_modules
2+
target
3+
.vscode
4+
.settings
5+
.project
6+
.classpath
7+
webpack.generated.js
8+
package-lock.json
9+
package.json
10+
webpack.config.js
11+
/error-screenshots
12+
drivers
13+
tsconfig.json
14+
.idea
15+
types.d.ts
16+
/frontend/generated
17+
/frontend/index.html
18+
vite.generated.ts
19+
vite.config.ts
20+
/src/main/dev-bundle

‎LICENSE‎

Lines changed: 210 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,210 @@
1+
All parts, except the contents of the documentation module, are licenced
2+
under Apache License v2.0. See the license text below.
3+
4+
The documentation is licensed under Creative Commons CC-BY-ND 2.0
5+
(http://creativecommons.org/licenses/by-nd/2.0/legalcode).
6+
7+
8+
-----------------------------------------------------------------------------
9+
10+
Apache License
11+
Version 2.0, January 2004
12+
http://www.apache.org/licenses/
13+
14+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
15+
16+
1. Definitions.
17+
18+
"License" shall mean the terms and conditions for use, reproduction,
19+
and distribution as defined by Sections 1 through 9 of this document.
20+
21+
"Licensor" shall mean the copyright owner or entity authorized by
22+
the copyright owner that is granting the License.
23+
24+
"Legal Entity" shall mean the union of the acting entity and all
25+
other entities that control, are controlled by, or are under common
26+
control with that entity. For the purposes of this definition,
27+
"control" means (i) the power, direct or indirect, to cause the
28+
direction or management of such entity, whether by contract or
29+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
30+
outstanding shares, or (iii) beneficial ownership of such entity.
31+
32+
"You" (or "Your") shall mean an individual or Legal Entity
33+
exercising permissions granted by this License.
34+
35+
"Source" form shall mean the preferred form for making modifications,
36+
including but not limited to software source code, documentation
37+
source, and configuration files.
38+
39+
"Object" form shall mean any form resulting from mechanical
40+
transformation or translation of a Source form, including but
41+
not limited to compiled object code, generated documentation,
42+
and conversions to other media types.
43+
44+
"Work" shall mean the work of authorship, whether in Source or
45+
Object form, made available under the License, as indicated by a
46+
copyright notice that is included in or attached to the work
47+
(an example is provided in the Appendix below).
48+
49+
"Derivative Works" shall mean any work, whether in Source or Object
50+
form, that is based on (or derived from) the Work and for which the
51+
editorial revisions, annotations, elaborations, or other modifications
52+
represent, as a whole, an original work of authorship. For the purposes
53+
of this License, Derivative Works shall not include works that remain
54+
separable from, or merely link (or bind by name) to the interfaces of,
55+
the Work and Derivative Works thereof.
56+
57+
"Contribution" shall mean any work of authorship, including
58+
the original version of the Work and any modifications or additions
59+
to that Work or Derivative Works thereof, that is intentionally
60+
submitted to Licensor for inclusion in the Work by the copyright owner
61+
or by an individual or Legal Entity authorized to submit on behalf of
62+
the copyright owner. For the purposes of this definition, "submitted"
63+
means any form of electronic, verbal, or written communication sent
64+
to the Licensor or its representatives, including but not limited to
65+
communication on electronic mailing lists, source code control systems,
66+
and issue tracking systems that are managed by, or on behalf of, the
67+
Licensor for the purpose of discussing and improving the Work, but
68+
excluding communication that is conspicuously marked or otherwise
69+
designated in writing by the copyright owner as "Not a Contribution."
70+
71+
"Contributor" shall mean Licensor and any individual or Legal Entity
72+
on behalf of whom a Contribution has been received by Licensor and
73+
subsequently incorporated within the Work.
74+
75+
2. Grant of Copyright License. Subject to the terms and conditions of
76+
this License, each Contributor hereby grants to You a perpetual,
77+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78+
copyright license to reproduce, prepare Derivative Works of,
79+
publicly display, publicly perform, sublicense, and distribute the
80+
Work and such Derivative Works in Source or Object form.
81+
82+
3. Grant of Patent License. Subject to the terms and conditions of
83+
this License, each Contributor hereby grants to You a perpetual,
84+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
85+
(except as stated in this section) patent license to make, have made,
86+
use, offer to sell, sell, import, and otherwise transfer the Work,
87+
where such license applies only to those patent claims licensable
88+
by such Contributor that are necessarily infringed by their
89+
Contribution(s) alone or by combination of their Contribution(s)
90+
with the Work to which such Contribution(s) was submitted. If You
91+
institute patent litigation against any entity (including a
92+
cross-claim or counterclaim in a lawsuit) alleging that the Work
93+
or a Contribution incorporated within the Work constitutes direct
94+
or contributory patent infringement, then any patent licenses
95+
granted to You under this License for that Work shall terminate
96+
as of the date such litigation is filed.
97+
98+
4. Redistribution. You may reproduce and distribute copies of the
99+
Work or Derivative Works thereof in any medium, with or without
100+
modifications, and in Source or Object form, provided that You
101+
meet the following conditions:
102+
103+
(a) You must give any other recipients of the Work or
104+
Derivative Works a copy of this License; and
105+
106+
(b) You must cause any modified files to carry prominent notices
107+
stating that You changed the files; and
108+
109+
(c) You must retain, in the Source form of any Derivative Works
110+
that You distribute, all copyright, patent, trademark, and
111+
attribution notices from the Source form of the Work,
112+
excluding those notices that do not pertain to any part of
113+
the Derivative Works; and
114+
115+
(d) If the Work includes a "NOTICE" text file as part of its
116+
distribution, then any Derivative Works that You distribute must
117+
include a readable copy of the attribution notices contained
118+
within such NOTICE file, excluding those notices that do not
119+
pertain to any part of the Derivative Works, in at least one
120+
of the following places: within a NOTICE text file distributed
121+
as part of the Derivative Works; within the Source form or
122+
documentation, if provided along with the Derivative Works; or,
123+
within a display generated by the Derivative Works, if and
124+
wherever such third-party notices normally appear. The contents
125+
of the NOTICE file are for informational purposes only and
126+
do not modify the License. You may add Your own attribution
127+
notices within Derivative Works that You distribute, alongside
128+
or as an addendum to the NOTICE text from the Work, provided
129+
that such additional attribution notices cannot be construed
130+
as modifying the License.
131+
132+
You may add Your own copyright statement to Your modifications and
133+
may provide additional or different license terms and conditions
134+
for use, reproduction, or distribution of Your modifications, or
135+
for any such Derivative Works as a whole, provided Your use,
136+
reproduction, and distribution of the Work otherwise complies with
137+
the conditions stated in this License.
138+
139+
5. Submission of Contributions. Unless You explicitly state otherwise,
140+
any Contribution intentionally submitted for inclusion in the Work
141+
by You to the Licensor shall be under the terms and conditions of
142+
this License, without any additional terms or conditions.
143+
Notwithstanding the above, nothing herein shall supersede or modify
144+
the terms of any separate license agreement you may have executed
145+
with Licensor regarding such Contributions.
146+
147+
6. Trademarks. This License does not grant permission to use the trade
148+
names, trademarks, service marks, or product names of the Licensor,
149+
except as required for reasonable and customary use in describing the
150+
origin of the Work and reproducing the content of the NOTICE file.
151+
152+
7. Disclaimer of Warranty. Unless required by applicable law or
153+
agreed to in writing, Licensor provides the Work (and each
154+
Contributor provides its Contributions) on an "AS IS" BASIS,
155+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
156+
implied, including, without limitation, any warranties or conditions
157+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
158+
PARTICULAR PURPOSE. You are solely responsible for determining the
159+
appropriateness of using or redistributing the Work and assume any
160+
risks associated with Your exercise of permissions under this License.
161+
162+
8. Limitation of Liability. In no event and under no legal theory,
163+
whether in tort (including negligence), contract, or otherwise,
164+
unless required by applicable law (such as deliberate and grossly
165+
negligent acts) or agreed to in writing, shall any Contributor be
166+
liable to You for damages, including any direct, indirect, special,
167+
incidental, or consequential damages of any character arising as a
168+
result of this License or out of the use or inability to use the
169+
Work (including but not limited to damages for loss of goodwill,
170+
work stoppage, computer failure or malfunction, or any and all
171+
other commercial damages or losses), even if such Contributor
172+
has been advised of the possibility of such damages.
173+
174+
9. Accepting Warranty or Additional Liability. While redistributing
175+
the Work or Derivative Works thereof, You may choose to offer,
176+
and charge a fee for, acceptance of support, warranty, indemnity,
177+
or other liability obligations and/or rights consistent with this
178+
License. However, in accepting such obligations, You may act only
179+
on Your own behalf and on Your sole responsibility, not on behalf
180+
of any other Contributor, and only if You agree to indemnify,
181+
defend, and hold each Contributor harmless for any liability
182+
incurred by, or claims asserted against, such Contributor by reason
183+
of your accepting any such warranty or additional liability.
184+
185+
END OF TERMS AND CONDITIONS
186+
187+
APPENDIX: How to apply the Apache License to your work.
188+
189+
To apply the Apache License to your work, attach the following
190+
boilerplate notice, with the fields enclosed by brackets "{}"
191+
replaced with your own identifying information. (Don't include
192+
the brackets!) The text should be enclosed in the appropriate
193+
comment syntax for the file format. We also recommend that a
194+
file or class name and description of purpose be included on the
195+
same "printed page" as the copyright notice for easier
196+
identification within third-party archives.
197+
198+
Copyright {yyyy} {name of copyright owner}
199+
200+
Licensed under the Apache License, Version 2.0 (the "License");
201+
you may not use this file except in compliance with the License.
202+
You may obtain a copy of the License at
203+
204+
http://www.apache.org/licenses/LICENSE-2.0
205+
206+
Unless required by applicable law or agreed to in writing, software
207+
distributed under the License is distributed on an "AS IS" BASIS,
208+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
209+
See the License for the specific language governing permissions and
210+
limitations under the License.

‎README.md‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
[![Published on Vaadin Directory](https://img.shields.io/badge/Vaadin%20Directory-published-00b4f0.svg)](https://vaadin.com/directory/component/template-addon)
2+
[![Stars on vaadin.com/directory](https://img.shields.io/vaadin-directory/star/app-layout-addon.svg)](https://vaadin.com/directory/component/template-addon)
3+
[![Build Status](https://jenkins.flowingcode.com/job/template-addon/badge/icon)](https://jenkins.flowingcode.com/job/template-addon)
4+
5+
# Template Add-on
6+
7+
This is a template project for building new Vaadin 24 add-ons
8+
9+
## Features
10+
11+
* List the features of your add-on in here
12+
13+
## Online demo
14+
15+
[Online demo here](http://addonsv24.flowingcode.com/template)
16+
17+
## Download release
18+
19+
[Available in Vaadin Directory](https://vaadin.com/directory/component/template-addon)
20+
21+
### Maven install
22+
23+
Add the following dependencies in your pom.xml file:
24+
25+
```xml
26+
<dependency>
27+
<groupId>org.vaadin.addons.flowingcode</groupId>
28+
<artifactId>template-addon</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+
43+
## Building and running demo
44+
45+
- git clone repository
46+
- mvn clean install jetty:run
47+
48+
To see the demo, navigate to http://localhost:8080/
49+
50+
## Release notes
51+
52+
See [here](https://github.com/FlowingCode/TemplateAddon/releases)
53+
54+
## Issue tracking
55+
56+
The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.
57+
58+
## Contributions
59+
60+
Contributions are welcome, but there are no guarantees that they are accepted as such.
61+
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.
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.
68+
- Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
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.
72+
73+
## License & Author
74+
75+
This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.
76+
77+
TEMPLATE_ADDON is written by Flowing Code S.A.
78+
79+
# Developer Guide
80+
81+
## Getting started
82+
83+
Add your code samples in this section
84+
85+
## Special configuration when using Spring
86+
87+
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.
88+
89+
To do so, just add ```com.flowingcode``` to the ```vaadin.whitelisted-packages``` property in ```src/main/resources/application.properties```, like:
90+
91+
```vaadin.whitelisted-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode```
92+
93+
More information on Spring whitelisted configuration [here](https://vaadin.com/docs/latest/integrations/spring/configuration/#configure-the-scanning-of-packages).

‎assembly/MANIFEST.MF‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
Manifest-Version: 1.0
2+
Vaadin-Package-Version: 1
3+
Vaadin-Addon: ${project.build.finalName}.${project.packaging}
4+
Implementation-Vendor: ${organization.name}
5+
Implementation-Title: ${project.name}
6+
Implementation-Version: ${project.version}

‎assembly/assembly.xml‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<assembly
3+
xmlns="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2"
4+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
5+
xsi:schemaLocation="http://maven.apache.org/plugins/maven-assembly-plugin/assembly/1.1.2 http://maven.apache.org/xsd/assembly-1.1.2.xsd">
6+
<id>flowing-addon</id>
7+
8+
<formats>
9+
<format>zip</format>
10+
</formats>
11+
12+
<!-- Do not use because we must put META-INF/MANIFEST.MF there. -->
13+
<includeBaseDirectory>false</includeBaseDirectory>
14+
15+
<fileSets>
16+
<fileSet>
17+
<directory>.</directory>
18+
<includes>
19+
<include>LICENSE</include>
20+
<include>README.md</include>
21+
</includes>
22+
</fileSet>
23+
<fileSet>
24+
<directory>target</directory>
25+
<outputDirectory></outputDirectory>
26+
<includes>
27+
<include>*.jar</include>
28+
<include>*.pdf</include>
29+
</includes>
30+
<excludes>
31+
<exclude>*-demo.jar</exclude>
32+
</excludes>
33+
</fileSet>
34+
</fileSets>
35+
36+
<files>
37+
<!-- This is vaadin.com/directory related manifest needed in the
38+
zip package -->
39+
<file>
40+
<source>assembly/MANIFEST.MF</source>
41+
<outputDirectory>META-INF</outputDirectory>
42+
<filtered>true</filtered>
43+
</file>
44+
</files>
45+
</assembly>

0 commit comments

Comments
 (0)