Merge branch 'wip_repo-documentation' into 'master'

Update the documentation for the repository

See merge request !25

README.md

-# iCity TP3.1 Dashboard
+# Energy Dashboard Prototype
 
-Development of dashboard for Bosch Schwieberdingen
\ No newline at end of file
+A prototype of an energy dashboard for the Bosch Schwieberdingen facility. The development of this dashboard was carried out as part of sub-project 3.1 (_Effizienzsteigerung durch intelligente Vernetzung von Erzeugern und Verbrauchern in Gewerbegebieten am Beispiel der Robert Bosch GmbH, Standort Schwieberdingen_) of the iCity project.
+
+## Features
+
+- Retrieve raw observations at 15 minute and 60 minute sampling rates
+
+- Aggregate the raw observations for daily or monthly intervals. The currently available aggregation options are `sum`, `maximum`, `minimum` and `average`
+
+- Visualize the raw and aggregated observations using four types of charts: line, heatmap, scatter plot and column. These charts are based on the [Highcharts](https://www.highcharts.com/blog/products/highcharts/) JavaScript library
+
+## Installation
+
+- Clone this repository
+
+- Create a `config.mjs` file and place it in the root of the `public/js` directory. This file should have the following structure:
+
+```javascript
+const CESIUM_ION_ACCESS_TOKEN = "your_cesium_ion_token";
+const SENSORTHINGS_API_BASE_URL = "your_sensorthingsapi_server_url";
+export { CESIUM_ION_ACCESS_TOKEN, SENSORTHINGS_API_BASE_URL };
+```
+
+- Install the application's dependencies
+
+```bash
+$ npm i
+```
+
+- Start the application (which should be available at `http://localhost:3000`)
+
+```bash
+$ nodemon index.js
+```

index.js

 const express = require("express");
+const favicon = require("express-favicon");
 
 const app = express();
 const port = process.env.PORT || 3000;
 
 app.use(express.static("public"));
 
+app.use(favicon(__dirname + "/public/favicon.ico"));
+
 app.get("/", (req, res) => {
   res.sendFile(__dirname + "/index.html");
 });

package.json

 {
-  "name": "chart-visualization",
+  "name": "icity-tp31-energy-dashboard",
   "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
+  "description": "A prototype for an energy dashboard for the Bosch Schwieberdingen facility.",
+  "keywords": [
+    "dashboard",
+    "sensors",
+    "energy"
+  ],
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "express": "^4.17.1"
+    "express": "^4.17.1",
+    "express-favicon": "^2.0.1"
+  },
+  "devDependencies": {
+    "nodemon": "^2.0.13"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://transfer.hft-stuttgart.de/gitlab/icity/energydashboard"
   }
 }

index.html → public/index.html

@@ -9,8 +9,8 @@
     />
     <meta name="description" content="" />
     <meta name="author" content="" />
-    <title>Dashboard - iCity Bosch</title>
-    <link href="css/thirdparty/styles.css" rel="stylesheet" />
+    <title>iCity Energy Dashboard</title>
+    <link href="./css/thirdparty/styles.css" rel="stylesheet" />
     <link
       href="https://cdn.datatables.net/1.10.20/css/dataTables.bootstrap4.min.css"
       rel="stylesheet"
@@ -19,7 +19,7 @@
 
     <!--     
     CUSTOM CSS -->
-    <link href="css/stylesCustom.css" rel="stylesheet" />
+    <link href="./css/stylesCustom.css" rel="stylesheet" />
 
     <!-- Font Awesome icons -->
     <script
@@ -60,19 +60,23 @@
       src="https://cdn.jsdelivr.net/npm/bootstrap@4.5.3/dist/js/bootstrap.bundle.min.js"
       crossorigin="anonymous"
     ></script>
-    <script src="js/thirdparty/scripts.js"></script>
+    <script src="./js/thirdparty/scripts.js"></script>
 
     <!-- vanillaSelectBox -->
-    <link href="css/thirdparty/vanillaSelectBox.css" rel="stylesheet" />
+    <link href="./css/thirdparty/vanillaSelectBox.css" rel="stylesheet" />
 
     <!--     
     Custom JS -->
-    <script defer type="module" src="js/appCesium.js"></script>
-    <script defer type="module" src="js/appChart.js"></script>
+    <script defer type="module" src="./js/appCesium.js"></script>
+    <script defer type="module" src="./js/appChart.js"></script>
+
+    <!--     
+    Favicon -->
+    <link rel="icon" href="/public/favicon.ico" />
   </head>
   <body class="sb-nav-fixed">
     <nav class="sb-topnav navbar navbar-expand navbar-dark bg-dark">
-      <a class="navbar-brand" href="index.html">iCity Bosch Dashboard</a>
+      <a class="navbar-brand" href="index.html">Energy Dashboard</a>
       <button
         class="btn btn-link btn-sm order-1 order-lg-0"
         id="sidebarToggle"
@@ -100,9 +104,9 @@
       <div id="layoutSidenav_content">
         <main>
           <div class="container-fluid">
-            <h1 class="mt-4">Dashboard</h1>
+            <!-- <h1 class="mt-4">Dashboard</h1> -->
             <ol class="breadcrumb mb-4">
-              <li class="breadcrumb-item active">Dashboard</li>
+              <li class="breadcrumb-item active"></li>
             </ol>
 
             <div class="row">