README.md

template-java-API

Template for an Open Source Java Project

This is used as a set of information for students' projects.

Content

This Java project contains a simple API created using spring-boot, tested with junit and spring-boot and documented with swagger using springdoc.

Continuous integration (CI) is managed using GitHub Actions.
Test coverage by JaCoCo and codecov.
Code quality is assessed with SonarCloud.

Step-by-step tutorial

Each step of this tutorial is detailed in the associated issues.

• Create Java API
• Test the API
• Make API swagger documentation
• GitHub actions to build and test
• Generate test coverage
• Code quality check
• Add license
• Create Github pages
• Create readme
• Publish release