To start your application in the dev profile, run:
./gradlew
To build the final jar and optimize the basicSample application for production, run:
./gradlew -Pprod clean bootJar
To ensure everything worked, run:
java -jar build/libs/*.jar
To package your application as a war in order to deploy it to an application server, run:
./gradlew -Pprod -Pwar clean bootWar
To launch your application's tests, run:
./gradlew test integrationTest jacocoTestReport
For more information, refer to the [Running tests page][].
Sonar is used to analyse code quality. You can start a local Sonar server (accessible on http://localhost:9001) with:
docker-compose -f src/main/docker/sonar.yml up -d
Note: we have turned off authentication in src/main/docker/sonar.yml for out of the box experience while trying out SonarQube, for real use cases turn it back on.
You can run a Sonar analysis with using the sonar-scanner or by using the gradle plugin.
Then, run a Sonar analysis:
./gradlew -Pprod clean check jacocoTestReport sonarqube
You can use Docker to improve your JHipster development experience. A number of docker-compose configuration are available in the src/main/docker folder to launch required third party services.
For example, to start a mysql database in a docker container, run:
docker-compose -f src/main/docker/mysql.yml up -d
To stop it and remove the container, run:
docker-compose -f src/main/docker/mysql.yml down
You can also fully dockerize your application and all the services that it depends on. To achieve this, first build a docker image of your app by running:
./gradlew bootJar -Pprod jibDockerBuild
Then run:
docker-compose -f src/main/docker/app.yml up -d
- With this skeleton, we can easily start a server application using Java Spring Boot.
- Rather than spending time on the project setup, get on with the important stuff right away.
Take it for a test drive. We'd love to hear any feedback you have or if you've thought of a new feature.
| Name | Description |
|---|---|
| .github | Contains GitHub settings and configurations, including the GitHub Actions workflows |
| build.gradle | Contains all your gradle dependencies |
| sonar-project.properties | Contains sonar properties |
| src/main/java/com/spring/rest | This package contains all the sub packages |
| src/main/java/com/spring/rest/aop | This package contains AOP Logging (Aspect-Oriented Programming) |
| src/main/java/com/spring/rest/config | This package contains all the configuration files |
| src/main/java/com/spring/rest/domain | This package contains DTOs, Ports & Service implementations |
| src/main/java/com/spring/rest/domain/dto | This package contains Data Transfer Objects |
| src/main/java/com/spring/rest/domain/port | This package contains Application Programming Interface (API) & Service Provider Interface (SPI) |
| src/main/java/com/spring/rest/domain/port/api | This package contains the service ports for services |
| src/main/java/com/spring/rest/domain/port/spi | This package contains the persistence ports for JPA Adapters |
| src/main/java/com/spring/rest/domain/service/ | This package contains the service implementations for service ports |
| src/main/java/com/spring/rest/infrastructure/ | This package contains JPA Adaptors, Entities, Repositories |
| src/main/java/com/spring/rest/infrastructure/adaptor | This package contains JPA Adapters which implements Persistence Ports |
| src/main/java/com/spring/rest/infrastructure/entity | This package contains the entities and their database mappings |
| src/main/java/com/spring/rest/infrastructure/repository | This package contains Repositories which are extended by JpaRepository |
| src/main/java/com/spring/rest/mapper | This package contains mappers for converting Entities to DTOs |
| src/main/java/com/spring/rest/rest | This package contains Controllers, Custom Exceptions & VM |
| src/main/java/com/spring/rest/security | This package contains JWT & Security Utils |
| src/main/java/com/spring/rest/BasicSampleApp.java | This is a sample Spring Boot Application |
| src/main/java/resources/config/liquibase | This package contains Liquibase database change logs |
| src/main/java/com/spring/config | This package contains Configuration files application.yml (-dev , -prob, -tls) |
| src/test/java/com/spring/rest | This package contains integration tests |
- Immediate implementation
- Focus on the domain of the application
- Possibility of changes
- Expected test
- Optimal result
- Logger
- Request Response
- Database
- Swagger/Open API