Skip to content

Latest commit

 

History

History
325 lines (256 loc) · 7.94 KB

README.md

File metadata and controls

325 lines (256 loc) · 7.94 KB

generator-jvm NPM version Build Status Dependency Status

Generate JVM (java, kotlin, scala) project with gradle / maven build systems and docker / docker-compose for rapid development

Installation

First, install Yeoman and generator-jvm using npm (we assume you have pre-installed node.js).

npm install -g yo
npm install -g generator-jvm

npm audit

It's not recommended, but if you really need, you can install npm packages without audit by using:

npm install --no-audit

Usage

Then generate your new project using command line options (name and type):

yo jvm --name my-awesom-java-project --type java
yo jvm -n spring-boot-kotlin-project -t kotlin-spring-boot
cd my-awesom-java-project

Then generate your new project using prompt:

yo jvm
# enter projectDirectory or just press enter (default: app)
# chose projectType (default: java)
cd app

using gradle

idea build.gradle
bash gradlew

using maven

idea pom.xml
bash mvnw

docker-compose

# gradle
bash gradlew composeUp
# maven
bash mvnw com.dkanejs.maven.plugins:docker-compose-maven-plugin:1.0.1:up

What's inside?

vertx web project

  • java 8 based Vert.x web project
  • support fatjar
  • support kotlin or java
  • support maven
  • support gradle
  • docker / docker-compose support

type options:

  • java-vertx

spring cloud function web project

  • java 8 based spring-cloud-function-web project
  • spring-boot 2 / spring framework 5
  • support fatjar
  • support executable bash jar
  • support kotlin or java
  • support maven
  • support gradle
  • docker / docker-compose support

type options:

  • java-spring-cloud-function-web
  • kotlin-spring-cloud-function-web

spring-boot 2 / spring framework 5 project

  • java 8 based project
  • spring-boot 2 / spring framework 5
  • support fatjar
  • support executable bash jar
  • support kotlin or java
  • support maven
  • support gradle
  • vavr (javaslang)
  • lombok (slf4j + logback logging)
  • support testing with junit 4 / 5
  • docker / docker-compose support

type options:

  • java-spring-boot
  • kotlin-spring-boot

spring-boot 1 / spring framework 4 project

  • java 8 based project
  • spring-boot 1 / spring framework 4
  • support fatjar
  • support executable bash jar
  • support kotlin or java
  • support maven
  • support gradle
  • vavr (javaslang)
  • lombok (slf4j + logback logging)
  • support testing with junit 4 / 5
  • docker / docker-compose support

type options:

  • java-spring-boot-1.x
  • kotlin-spring-boot-1.x

kotlin parent multi project

  • java 8 based parent multi project
  • support kotlin
  • support fatjar
  • support executable bash jar
  • support kotlin
  • support maven
  • support gradle
  • vavr (javaslang)
  • lombok (slf4j + logback logging)
  • support testing with junit 4 / 5
  • docker / docker-compose support

java-ee-faces project

  • javaee 8.0 project
  • JSF using mojarrra 2.2.16 faces implementation
  • lombok (slf4j + logback logging)
  • support maven
  • support gradle
  • docker / docker-compose support (Glassfish 5.0 / JBOSS EAP 7.1)

java-ee CDI full multi project

  • javaee 8.0 project
  • EAR with EJB + CDI configured
  • EJB3 (business services module: ejb-services)
  • EJB3 (JPA repositories module: ejb-data with embedded H2database for simplicity)
  • JAX-RS REST API
  • WEB/HTML5 static content
  • Servlet and JSP with EJB usage
  • lombok (slf4j + logback logging)
  • vavr (javaslang)
  • support maven
  • support gradle
  • docker / docker-compose support (JBOSS EAP 7.1)

java-ee EJB full multi project

  • javaee 8.0 project
  • EAR without CDI at all, but could be easily added (see java-ee-cdi-multi-project)
  • EJB3 (business services module: ejb-services)
  • EJB3 (JPA repositories module: ejb-data with embedded H2database for simplicity)
  • JAX-RS REST API
  • WEB/HTML5 static content
  • Servlet and JSP with EJB usage
  • lombok (slf4j + logback logging)
  • vavr (javaslang)
  • support maven
  • support gradle
  • docker / docker-compose support (JBOSS EAP 7.1)

kotlin java-ee project

  • javaee 8.0 project
  • lombok (slf4j + logback logging)
  • vavr (javaslang)
  • support kotlin
  • support maven
  • support gradle
  • support testing with junit 4 / 5
  • docker / docker-compose support (JBOSS EAP 7.1)

kotlin fat project

  • java 8 based project
  • support kotlin
  • support fatjar
  • support maven
  • support gradle
  • slf4j + logback logging
  • support application scripts when using gradle
  • docker / docker-compose support

scala akka-persistence gradle project

  • scala 2.12 based project
  • akka-persistence
  • lombok (slf4j + logback logging)
  • support gradle and application executable scripts
  • support testing using junit 4, scalactic, scalatest, specs2
  • docker / docker-compose support

java-akka project

  • java 8 based project
  • akka-actor
  • lombok (slf4j + logback logging)
  • vavr (javaslang)
  • support fatjar
  • support maven
  • support gradle
  • support application scripts when using gradle
  • support testing with junit 4 / 5
  • docker / docker-compose support

java-ee (micro-profile) project

  • java 8 based project
  • javaee 8.0 using wildfly-swarm micro-profile
  • support fatjar
  • support executable bash jar
  • support kotlin
  • support maven
  • support gradle
  • vavr (javaslang)
  • lombok (slf4j + logback logging)
  • support testing with junit 4 / 5
  • docker / docker-compose support

scala project

  • scala 2.12 based project
  • lombok (slf4j + logback logging)
  • support fatjar
  • support maven
  • support gradle
  • support application executable scripts when using gradle
  • support testing using junit 4, scalactic, scalatest, specs2
  • docker / docker-compose support

java-ee project

  • java 8 based project
  • javaee 8.0
  • lombok (slf4j + logback logging)
  • vavr (javaslang)
  • support maven
  • support gradle
  • support testing with junit 4 / 5
  • docker / docker-compose support (JBOSS EAP 7)

java parent multi project

  • java 8 based parent multi project
  • vavr (javaslang)
  • support maven
  • support gradle
  • docker / docker-compose support

scala_2.11 project

  • scala 2.11 based project
  • lombok (slf4j + logback logging)
  • support fatjar
  • support maven
  • support gradle
  • support application scripts (gradle shadow plugin)
  • support testing using junit 4, scalactic, scalatest, specs2
  • docker / docker-compose support

java project

  • java 8 based project
  • lombok (slf4j + logback logging)
  • vavr (javaslang)
  • support fatjar
  • support maven
  • support gradle
  • support application scripts when using gradle
  • support testing with junit 4 / 5
  • docker / docker-compose support

Also inside all projects available

  • FindBugs maven / gradle plugins functionality ./gradlew check ./mvnw verify site
  • Ascii documentation (asciidoctor maven / gradle plugins functionality) ./gradlew asciidoctor
  • Artifact deployment (local maven repositories) ./gradlew publish ./mvnw deploy

Getting To Know Yeoman

  • Yeoman has a heart of gold.
  • Yeoman is a person with feelings and opinions, but is very easy to work with.
  • Yeoman can be too opinionated at times but is easily convinced not to be.
  • Feel free to learn more about Yeoman.

License

MIT © Maksim Kostromin