Merge pull request #11 from FraunhoferIOSB/development

Merge development into staging

.github/workflows/versioning-workflow.yml

@@ -14,16 +14,12 @@ jobs:
   release:
     name: Versioning
     runs-on: ubuntu-latest
-    permissions:
-      contents: write # to be able to publish a GitHub release
-      issues: write # to be able to comment on released issues
-      pull-requests: write # to be able to comment on released pull requests
-      id-token: write # to enable use of OIDC for npm provenance
     steps:
       - name: Checkout
         uses: actions/checkout@v3
         with:
           fetch-depth: 0
+          persist-credentials: false
       - name: Setup Node.js
         uses: actions/setup-node@v3
         with:
@@ -34,5 +30,5 @@ jobs:
         run: npm audit signatures
       - name: Release
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
         run: npx semantic-release

.releaserc.yml

@@ -6,7 +6,6 @@
     ["@semantic-release/npm", {
       "npmPublish": false
     }],
-    ["@semantic-release/github"],
     ["@semantic-release/git", {
       "assets": ["package.json"],
       "message": "chore(Release): ${nextRelease.version}\n\n${nextRelease.notes}"

Dockerfile

@@ -2,7 +2,8 @@
 FROM node:lts-alpine3.16 as build
 WORKDIR /usr/src/app
 COPY . .
-RUN npm install -w=aas-server -w=aas-portal
+RUN apk add g++ make py3-pip
+RUN npm install
 RUN node create-app-info.js
 RUN npm run build
 

Dockerfile.aas-portal

@@ -2,7 +2,7 @@
 FROM node:lts-alpine3.16 as build
 WORKDIR /usr/src/app
 COPY . .
-RUN npm ci -w=aas-portal
+RUN npm install
 RUN npm run aas-portal:build
 
 FROM nginx:latest as aas-portal

Dockerfile.aas-server

@@ -2,7 +2,7 @@
 FROM node:lts-alpine3.16 as build
 WORKDIR /usr/src/app
 COPY . .
-RUN npm install -w=aas-server
+RUN npm install
 RUN node create-app-info.js
 RUN npm run aas-server:build
 

README.md

@@ -1,22 +1,29 @@
 # AASPortal [![Documentation Status](https://readthedocs.org/projects/aasportal/badge/?version=latest "Documentation Status")](https://aasportal.readthedocs.io/en/latest/?badge=latest)
 
 ![AASPortal Logo <](./docs/source/images/AASPortal_mid.png "AASPortal Logo")
-**AASPortal** is a Node.js based web portal for the visualization and management of Asset Administration Shells (AAS). The implementation uses the concepts of the document "Details of the Asset Administration Shell" published on https://www.plattform-i40.de and licensed under Creative Commons CC BY 4.0. 
 
+**AASPortal** is a Node.js based web portal for the visualization and management of Asset Administration Shells (AAS). The implementation uses the concepts of the document "Details of the Asset Administration Shell" published on https://www.plattform-i40.de and licensed under Creative Commons CC BY 4.0. 
 Check out the [Getting Started](./docs/source/gettingstarted.md) section to learn how to setup Visual Studio Code and start using and developing the *AASPortal*. Learn more about the [Architecture](./docs/source/architecture.md) of *AASPortal*, and check out the [Usage](./docs/source/usage.md) section to learn about available search filters for AAS and which Endpoints can be connected to the *AASPortal*.
 
 For more details about the AASPortal see the full documentation :blue_book: [here](https://aasportal.readthedocs.io/en/latest/?badge=latest).
 **AASPortal is under active development and we are looking forward to your active contributions!**
+
 ## Prerequisites
 - Visual Studio Code
 - Node.js v18.10.0
 - GIT 2.36.0.windows
-- Docker Desktop 4.x
+- Docker Desktop 4.x  
 
 ## Getting Started
 You can find a detailed documentation :blue_book: [here](https://aasportal.readthedocs.io/)
 
-## Usage
+### Dockerhub
+
+The easiest way to run AASPortal locally, is using the latest "all in one" image from Dockerhub:
+
+`docker run -p 80:80 fraunhoferiosb/aasportal_aio`
+
+Then go to http://localhost/ in your browser and enjoy.
 
 ### Setup Visual Studio Code
 The preferred development environment is Visual Studio Code. Clone *AASPortal*'s GIT repository. Open aasportal in Visual Studio Code. In a terminal window execute the the following commands:
@@ -34,9 +41,7 @@ The following command creates and executes a Docker image:
 
 `npm run start`
 
-Go to:
-
-    http://localhost/
+Go to: http://localhost/
 
 ## Changelog
 

docs/source/gettingstarted.md

@@ -26,6 +26,13 @@ aasportal
 
 ```
 
+## Docker(hub)
+The easiest way to run AASPortal locally, is using the latest "all in one" image from Dockerhub:
+
+`docker run -p 80:80 fraunhoferiosb/aasportal_aio`
+
+Then go to http://localhost/ in your browser and enjoy.
+
 ## Setup Visual Studio Code
 The preferred development environment is Visual Studio Code. Clone *AASPortal*'s GIT repository. Open aasportal in Visual Studio Code. In a terminal window execute the the following commands:
 
@@ -63,7 +70,9 @@ or the name (idShort) of the AAS
     http://localhost/?id=Bosch_NexoPistolGripNutrunner
 
 ## AASServer 
-ToDo.
+AASServer is a Node.js server application based on the Express framework. The main feature of AASServer is the provision of Asset Administration Shells from different data sources (AASX server, OPC UA server, file system). AASServer can read Asset Administration Shells in JSON, XML and OPC UA format. An Asset Administration Shell is always provided to a web client (AASPortal) in JSON version 3 format.
+
+AASServer provides a user management. Authentication of a user is based on Json Web Token. 
 
 ## Environment Variables
 | Name             |                                                                       | default                                        |

docs/source/index.md

@@ -5,7 +5,7 @@
 
 Check out the [Getting Started](gettingstarted.md) section to learn how to setup Visual Studio Code and start using and developing the *AASPortal*. Learn more about the [Architecture](architecture.md) of *AASPortal*, and check out the [Usage](usage.md) section to learn about available search filters for AAS and which Endpoints can be connected to the *AASPortal*.
 
-*This project is under active development and we are looking forward to your active contributions!*
+*This project is under active development and we are looking forward to your active contributions!!*
 
 ```{toctree} 
 :hidden: