definma-ui/src/app/documentation/documentation.component.html

<h2>Documentation</h2>

<p>
  Bosch IoT Cloud space where all applications are hosted:
  <a href="https://apps.sys.de1.bosch-iot-cloud.com/organizations/b28baba5-f95f-4ce5-bc9c-3f45acd1dfb2">
    https://apps.sys.de1.bosch-iot-cloud.com/organizations/b28baba5-f95f-4ce5-bc9c-3f45acd1dfb2
  </a><br>
  Find the API documentation here:
  <a href="https://definma-api.apps.de1.bosch-iot-cloud.com/api-doc/">
    https://definma-api.apps.de1.bosch-iot-cloud.com/api-doc/
  </a><br>
  Code repository UI
  <a href="https://sourcecode.socialcoding.bosch.com/users/vle2fe/repos/definma-ui">
    https://sourcecode.socialcoding.bosch.com/users/vle2fe/repos/definma-ui
  </a><br>
  Code repository API
  <a href="https://sourcecode.socialcoding.bosch.com/users/vle2fe/repos/definma-api">
    https://sourcecode.socialcoding.bosch.com/users/vle2fe/repos/definma-api
  </a><br>
</p>

<h4>Introduction</h4>

<p>
  <a [href]="api.hostName + '/static/intro-presentation/index.html'">
    View the presentation explaining the main functions
  </a>
</p>

<h4>User levels</h4>

<rb-table>
  <tr>
    <th></th>
    <th>prediction</th>
    <th>read</th>
    <th>write</th>
    <th>dev</th>
    <th>admin</th>
  </tr>
  <tr>
    <th>use prediction models</th>
    <td>specified ones</td>
    <td>specified ones</td>
    <td>specified ones</td>
    <td>all</td>
    <td>all</td>
  </tr>
  <tr>
    <th>read sample data</th>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
  </tr>
  <tr>
    <th>add samples/edit own</th>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
  </tr>
  <tr>
    <th>read spectral data</th>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
  </tr>
  <tr>
    <th>edit other's data</th>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
  </tr>
  <tr>
    <th>maintain templates</th>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
  </tr>
  <tr>
    <th>edit users</th>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-abort-frame"></span></td>
    <td><span class="rb-ic rb-ic-checkmark-frame"></span></td>
  </tr>
</rb-table>

<h4>Architecture</h4>

<img src="/assets/imgs/architecture.svg" alt="architecture" class="space-below">

<p>
  All applications are hosted in the bosch IoT Cloud. The API is hosted in a Node.js container, with a bound MongoDB
  instance. <br>
  The Angular UI is hosted in a staticfile container, serving the built Angular bundle. <br>
  Finally any machine learning models are hosted in Python containers.
</p>