/MavenRepositoryTemplate

A project to use as a template for new ones.

GNU General Public License v3.0GPL-3.0

MavenRepositoryTemplate

GitHub release

A project to use as a template for new ones.

Templates and guides:

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See Deployment for notes on how to deploy the project on a live system.

Prerequisites

What things you need to install the software and how to install them

Give examples

Installing

A step by step series of examples that tell you how to get a development env running

Say what the step will be

Give the example

And repeat

until finished

End with an example of getting some data out of the system or using it for a little demo

Running the tests

This project uses JUnit5 tests and they are configured to run automatically in the test life cycle of Maven. They can also be run with the command mvn test. Along with the code unit test, the code coverage is also measured. The test and code coverage reports generate in the site life cycle of Maven, or when using the mvn site command.

Break down into end to end tests

Explain what these tests test and why

Give an example

And coding style tests

Explain what these tests test and why

Give an example

Deployment

Add additional notes about how to deploy this on a live system

Built With

  • Maven - Dependency management
  • JUnit5 - Unit testing framework for Java
  • Log4j 2 - A logging package for Java

Contributing

Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests to us.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

Authors

  • FerMod (Ferran Tudela) - Initial work

See also the list of contributors who participated in this project.

License

This project is licensed under the GNU General Public License v3.0 - see the LICENSE file for details.

Changelog

To know more about the changes made between versions, you can go to the CHANGELOG file.

Acknowledgments

  • Hat tip to anyone whose code was used
  • Inspiration
  • etc