This repository serves as a template for Java projects:
- JDK for the runtime environment
- JUnit for the testing framework
- GitHub Actions for the continuous integration solution
- Checkstyle for the static analysis solution
- Google Java Format for the code formatting solution
- Maven for the package manager solution
- Clone the repository:
git clone https://github.com/ZFarooqi24/java-repo-template.git - Navigate to the project directory:
cd java-repo-template/tech-template - Build the project:
mvn package - Run tests:
mvn test
This template includes a GitHub Actions workflow that automatically runs tests on every push and pull request.
The project is set up with Checkstyle for static code analysis. We use Google's Checkstyle configuration, which is directly fetched from Checkstyle's official GitHub repository.
Chose Java from the dropdown menu as it's specifically tailored for Java and will correctly ignore the relative files and directories for a Java project
This project is licensed under the MIT License as it allows for minimal restrictions in its usage