Feature/vhvapm 531

.github/workflows/build-and-test-backend.yml

@@ -1,38 +1,30 @@
-# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
-# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven
-
-# This workflow uses actions that are not certified by GitHub.
-# They are provided by a third-party and are governed by
-# separate terms of service, privacy policy, and support
-# documentation.
-
-name: Backend CI
+name: Gradle Build
 
 on:
   push:
-    branches: [ "*" ]
-  pull_request:
-    branches: [ "*" ]
 
 jobs:
-  build-and-test:
+  build:
 
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      packages: write
 
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up JDK 21
-      uses: actions/setup-java@v4
-      with:
-        java-version: '21'
-        distribution: 'temurin'
-        cache: maven
-    - name: Build and test backend with Maven
-      run: mvn -B --update-snapshots package --file ./backend/pom.xml
-    - name: Copy build artifact to staging directory
-      run: mkdir staging && cp ./backend/target/*.jar staging
-    - name: Upload build artifact to packages 
-      uses: actions/upload-artifact@v4
-      with:
-        name: agentmanager-backend-snapshot
-        path: staging
+      - uses: actions/checkout@v4
+      - name: Set up JDK 21
+        uses: actions/setup-java@v4
+        with:
+          java-version: '21'
+          distribution: 'temurin'
+
+      - name: Setup Gradle
+        uses: gradle/actions/setup-gradle@417ae3ccd767c252f5661f1ace9f835f9654f2b5 # v3.1.0
+        with:
+          build-scan-publish: true
+          build-scan-terms-of-service-url: "https://gradle.com/terms-of-service"
+          build-scan-terms-of-service-agree: "yes"
+
+      - name: Build with Gradle
+        run: ./gradlew build

.gitignore

@@ -1,7 +1,35 @@
-/out/
-.DS_Store
-.idea
-*.iml
+# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider
+# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
 
-/agentmanager/frontend/src/.nuxt/
-/agentmanager/frontend/src/node_modules/
+# User-specific stuff
+.idea/
+
+# File-based project format
+*.iws
+
+# IntelliJ
+out/
+
+# mpeltonen/sbt-idea plugin
+.idea_modules/
+
+# JIRA plugin
+atlassian-ide-plugin.xml
+
+# Crashlytics plugin (for Android Studio and IntelliJ)
+com_crashlytics_export_strings.xml
+crashlytics.properties
+crashlytics-build.properties
+fabric.properties
+
+# Gradle Files
+.gradle
+# build-Folder in root-dir
+/build
+# ui artifact build
+/ui/build_packageClient/
+
+**/.DS_Store
+
+**/node_modules
+**/.nuxt

CONTRIBUTING.md

@@ -0,0 +1,49 @@
+# Contributing
+
+## IDE
+
+We recommend using [IntelliJ](https://www.jetbrains.com/idea/download/#section=windows) as IDE for contributing.
+
+## Formatting
+
+We have [spotless](https://github.com/diffplug/spotless) configured to format the code. You can run the following commands:
+
+- `./gradlew spotlessCheck` to validate the formatting of the code.
+- `./gradlew spotlessApply` to format the code.
+
+Be aware that the CI will fail if the code is not formatted correctly, as `spotlessCheck` is part of the build process.
+
+
+## Building
+
+### Prerequisites
+Please make sure you have the following tools installed on your machine:
+- A big cup of coffee
+- A Java Development Kit (JDK) with version 21 or higher
+- A working internet connection (for downloading dependencies)
+- Docker (optional, for running the application in a container)
+
+Thats it for now.
+
+### Backend
+To build the backend, simply run the following command in the root directory of the project:
+```shell
+./gradlew 
+```
+This will generate the backend jar file in the `server/build/libs` directory.
+
+> [!TIP]  
+> You might have installed an auto-formatter in your IDE. It may break the installed spotless code-style. In this case, the build will not be successfull. Please run ```./gradlew potlessApply``` to fix this issue.
+
+### Frontend
+To build the frontend, navigate to the `frontend/src` directory and run the following commands:
+```shell
+    npm install
+    npm run build
+```
+This will generate an entry point that launches a ready-to-run node server in the `frontend/src/.output` directory.
+
+You could also run the frontend in development mode by running:
+```shell
+    npm run dev
+```

README.md

@@ -0,0 +1,17 @@
+# Welcome to the InspectIT Gepard Config-Server
+InspectIT Gepard is an Extension for the OpenTelemetry Java agent,
+enhancing your application with custom monitoring capabilities.
+The agent is configured via a central configuration server,
+which is responsible for providing instrumentation-rules, -scopes and -action along to configuration settings to the agent.
+This repository contains the implementation of the configuration servers central component,
+along with a User Interface for managing agents easily.
+
+InspectIT Gepard is developed by Novatec Consulting GmbH and backed by VHV Group.
+It´s purpose is to replace the InspectIT Ocelot project with a more modern and flexible approach, utilizing the OpenTelemetry standard.
+
+## Getting Started
+Currently, the project is in an early stage of development and not yet ready for production use.
+However, if you want to try it out, you can follow the instructions in [CONTRIBUTING](./CONTRIBUTING.md).
+
+## Useful Links
+- [SonarCloud](https://sonarcloud.io/)