README.md

WCC: Platform Backend Service

• WCC: Platform Backend Service
  • How to start?
  • Setup locally
    • JAVA 21 with SDKMAN
    • Setup IntelliJ
      • Lombok
      • Enable Save Actions
      • Enable Checkstyle Warnings
      • Google Format
        • IntelliJ JRE Config
  • Run Locally
  • Open API Documentation
  • Quality Checks
    • Jacoco
    • PMD
    • SONAR
      • Install sonarqube docker image locally
      • Set-up wcc-backend project on local sonarQube instance
      • Perform SONAR ANALYSIS
  • Deploy application
    • Deploy with docker compose
      • Helpful commands with docker
    • Deploy with Fly.io
      • Setup Fly.io locally
      • Deploying to Fly.io

How to start?

1. Start by making a Fork of wcc-backend repository. Click on the Fork symbol in the top right corner.

2. Clone your new fork of the repository in the terminal/CLI on your computer with the following command:

git clone https://github.com/<your-github-username>/wcc-backend

Setup locally

JAVA 21 with SDKMAN

This project uses Java 21, you can run in 21.0.2 or 21.0.3. If you have installed a different version on your machine and don't want to remove it, you can use SDKMAN development tool.

• Install SDKMAN

Open your terminal and run the following command:

curl -s "https://get.sdkman.io" | bash
source "$HOME/.sdkman/bin/sdkman-init.sh"

• Check the list of available Java versions:

sdk list java

• Install the desired Java version

sdk install java 21.0.2-open 

• Use the specific java version in the current session on your terminal

sdk use java 21.0.2-open

Set the default Java version for your system:

• To set the newly installed Java version as the default:

sdk default java 21.0.2-open

• To verify if the java version is correct use:

java -version

Setup IntelliJ

Lombok

Install lombok plugin and enable Annotation Processing, as the image below:

Enable Save Actions

Enable Checkstyle Warnings

Install checkstyle plugin and the configuration will be enabled

Google Format

A google-java-format IntelliJ plugin is available from the plugin repository. To install it, go to your IDE's settings and select the Plugins category. Click the Marketplace tab, search for the google-java-format plugin, and click the Install button.

The plugin will be disabled by default. To enable it in the current project, go to File→Settings...→google-java-format Settings (or IntelliJ IDEA→Preferences...→Other Settings→google-java-format Settings on macOS) and check the Enable google-java-format checkbox. (A notification will be presented when you first open a project offering to do this for you.)

To enable it by default in new projects, use File→Other Settings→Default Settings....

When enabled, it will replace the normal Reformat Code and Optimize Imports actions.

IntelliJ JRE Config

The google-java-format plugin uses some internal classes that aren't available without extra configuration. To use the plugin, go to Help→Edit Custom VM Options... and paste in these lines:

--add-exports=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED
--add-exports=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED

Once you've done that, restart the IDE.

Run Locally

• Build and run tests

./gradlew clean build

Note: Make sure you have docker daemon running locally to be able to run integration test, by execute docker ps

• Start database

docker run --pull always --name surrealdb -p 8000:8000 -d surrealdb/surrealdb:latest start --user root --pass root --log debug

• Start Spring Boot Application (from your IDE):

./gradlew bootRun

Note: You can start application in a debug mode through your IDE.

IntelliJ IDEA: Select \src\main\java\com\wcc\platform\PlatformApplication.java and mouse right-click to select debugging option.

• Access application on http://localhost:8080/api/cms/v1/team

Open API Documentation

• Access swagger api and corresponding openAPI docs here

Quality Checks

Jacoco

• Generate Test reports and open coverage report

./gradlew test jacocoTestReport

• Check coverage minimum of 70%

./gradlew clean test jacocoTestCoverageVerification

PMD

• Run pmd checks in src folder

./gradlew pmdMain

• Run pmd for test

./gradlew pmdTest

SONAR

Install sonarqube docker image locally

• Make sure you have docker installed on your machine - Download the installer using the url https://docs.docker.com/get-docker/. ( Prefer Docker Desktop Application )
• Start the docker application. Double-click Docker.app to start Docker.

Get the “SonarQube” image using the command

docker pull sonarqube

Start the "SonarQube" instance

docker run -d --name sonarqube -e SONAR_ES_BOOTSTRAP_CHECKS_DISABLE=true -p 9000:9000 sonarqube:latest

• Access SonarQube dashboard - http://localhost:9000
  (default credentials ) login: admin password: admin

Ref: https://docs.sonarsource.com/sonarqube/latest/try-out-sonarqube/

Set-up wcc-backend project on local sonarQube instance

• Step 1

1. Select create a local project
2. "Project display name" = wcc-backend
3. "Project key" = wcc-backend
4. "Main branch name" = *

• Step 2

1. Choose the baseline for new code for this project
   select "Use the global setting"
2. Click "Create Project" at the bottom

• Step 3

Generate token to replace in the project.

1. Click "Locally" on the main dashboard
2. Generate a token on the next screen ( choose Expires in - No expiration) [ Click Generate]
3. Copy the token = "sqp_XXXXXXX" and replace in the file build.gradle.kts
   property("sonar.token", "PLACE_YOUR_TOKEN_HERE")

Perform SONAR ANALYSIS

./gradlew sonarQubeAnalysis -PlocalProfile

Deploy application

Deploy with docker compose

• Build and create jar

 ./gradlew clean bootJar`

• Start docker compose

docker compose -f docker/docker-compose.yml up --build

Note: This will create two Docker instances in your Docker desktop:

1. surrealdb
2. springboot-app

• Debug application

To debug application STOP the docker container of the application, springboot-app. Do not stop the container of the SurrealDB. Start the application from your IDE.

• Stop docker compose

cd docker
docker compose down

Helpful commands with docker

• List resources in docker container docker exec -it wcc-backend ls -al /app/resources

Deploy with Fly.io

Setup Fly.io locally

1. Install fly.io
2. Login fly auth login or create account fly auth signup
3. build create jar: ./gradlew clean bootJar
4. First deploy fly launch

Deploying to Fly.io

1. build create jar: ./gradlew clean bootJar
2. Update deploy fly deploy
3. Access the application here and the api for landing page here