Skip to content

Cmlbnd/SpringBoot-template

Repository files navigation

SAMPLE JAVA THREAD

Introduction

This software component is a sample for Adobe.


Prerequisite

You need to update the sr/main/resource/application-default.properties with your database and/or cloud information

$ gradle build

Be sure you are using Java Runtime Environment 1.8


Running the application

$ gradle bootRun

http:https://localhost:8080/api/v1/sample/endpoint1?Date=X&Time=Y

Api Documentation

https://*Deployment_url*/swagger-ui.html

Dependencies

  • ####DataBase

    • #####Backend
      • backend : for online mode
  • Messaging queue

    • Setted up connection with a cloud based queue (e.g SQS-AWS)

Code Quality

  • Copy the pre-push file present in your project to .git/hooks folder.
    cp pre-push .git/hooks
    chmod 766 .git/hooks/pre-push
    

This will run the test and checkstyle configuration before pushing the code to repo.

In order to set up the checkstyle on intellij, go to Settings > Checkstyle > + new checkstyle and import the checkstyle.xml (found in the config folder of this repository).
Then, go to preferences > Editor > Code Style and then add a new scheme and import the CodeStyle.xml file.

Code Coverage

  • Uses Jacaco gradle plugin to generate reports.
Running code coverage
 gradle test jacocoTestRepor
  • You should be able to see the reports in the build/reports/jacoco.
  • You can open the index.html file in the browser to view the reports.

Troubleshooting

Gradle build doesn't work
  • Change: version = getVersion() with version = 1
Missing database or run without
  • Remove
    • config
      • JmsConfig
      • PersistenceConfig
    • entity
    • repository

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published