Fix: Added missing documentation and configuration template

README.md

@@ -30,6 +30,7 @@ This is a C# program that takes command line arguments and generates various rep
 Before you can run and use the script, you need to ensure that the following dependencies and prerequisites are in place:
 
 1. The project's referenced .NET SDK(s) must be installed. Please refer to the project's source code for information on which .NET SDK(s) are required.
+2. Use the `appsettings.json` as a tempate or a base for your configuration of the script. Fill it out accordingly.
 
 Once you have all the necessary dependencies and prerequisites in place, you should be able to run and use this script.
 

src/KPI Generator/Program.cs

@@ -85,6 +85,7 @@ public class Program
 
         // Add Consul as a configuration source
         var configuration = configBuilder
+            .AddJsonFile("appsettings.json", optional: true, reloadOnChange: true)
             .AddConsul(
                 "coscine/Coscine.Infrastructure/KpiGenerator/appsettings",
                 options =>

src/KPI Generator/appsettings.json

+{
+  "ReportingConfiguration": {
+    "IsEnabled": true,
+    "Local": {
+      "StoragePath": "C:/coscine/reporting/"
+    },
+    "GitLab": {
+      "HostUrl": "https://git.rwth-aachen.de/",
+      "Token": "",
+      "Branch": "",
+      "ProjectId": 76546
+    },
+    "Organizations": {
+      "OtherOrganization": {
+        "Name": "Other",
+        "RorUrl": "https://ror.org/_other"
+      }
+    },
+    "FilesToKeepInRepo": [
+      "List_of_Reporting_Variables.xlsx",
+      "README.md"
+    ]
+  },
+  "KpiConfiguration": {
+    "ApplicationProfileKpi": {
+      "FileName": "application_profiles.json"
+    },
+    "ProjectKpi": {
+      "FileName": "projects.json"
+    },
+    "ResourceKpi": {
+      "FileName": "resources.json"
+    },
+    "SystemKpi": {
+      "FileName": "system_status.json",
+      "Maintenance": {
+        "Url": "",
+        "Username": "",
+        "Password": "",
+        "BasicAuthToken": ""
+      }
+    },
+    "UserKpi": {
+      "FileName": "users.json"
+    }
+  }
+}
\ No newline at end of file