A Maven Archetype for generating a Spring MVC project using Thymeleaf for the frontend.
- Creates the base for a Spring MVC project.
- Initial sample project including working persistence and exception handling
- Integrates with Thymeleaf for the view templates.
- Using Bootstrap 5 for the UI.
- Using Liquibase for database versioning.
- Integration with iText for generating PDFs.
- Fully configured POM, extending from bernardomg's Base POM, including features such as build validation, changes report or manifest configuration.
- Prepared for continuous integration with Github, [Github Workflow][github-workflow] and both [OSS Sonatype][sonatype] and [Github packages][github-packages]. Making a distinction between releases and development versions.
- Prepared for unit and integration tests suites. Created with JUnit and ready to be run with Surefire and Failsafe.
- A Maven site, using the Docs Maven Skin, for sharing the project's documentation along the Javadocs and various reports which range from code quality to changes log.
- Includes basic files such as readme, gitignore and license.
A sample project shows what this Archetype is capable of creating.
Documentation is always generated for the latest release, kept in the 'master' branch:
Documentation is also generated from the latest snapshot, taken from the 'develop' branch:
The documentation site is actually a Maven site, and its sources are included in the project. If required it can be generated by using the following Maven command:
mvn verify site
The verify phase is required, otherwise some of the reports won't be generated.
The application is coded in Java, using Maven to manage the project.
It is a Maven Archetype, and can be used through command line or an IDE as long as it is included in the local repository.
The archetype can be installed with the following Maven coordinates:
Group ID: com.bernardomg.maven.archetypes
Artifact ID: spring-mvc-thymeleaf-maven-archetype
Version: (Check POM or badges)
For example, to use it through command line type the following:
mvn archetype:generate -DarchetypeGroupId=com.bernardomg.maven.archetypes -DarchetypeArtifactId=spring-mvc-thymeleaf-maven-archetype -DarchetypeVersion=[version]
If using an IDE check its documentation to find out how to use Maven Archetypes, and how to add these to the local repository.
As an alternative, it is always possible to download the project from Github, and then install it using the usual Maven command:
mvn install
Any kind of help with the project will be well received, and there are two main ways to give such help:
- Reporting errors and asking for extensions through the issues management
- or forking the repository and extending the project
Issues are managed at the GitHub project issues tracker, where any Github user may report bugs or ask for new features.
If you wish to fork or modify the code, visit the GitHub project page, where the latest versions are always kept. Check the 'master' branch for the latest release, and the 'develop' for the current, and stable, development version.
The project has been released under the MIT License.