Staging

.github/workflows/build-and-publish-docker-images-workflow.yml

@@ -2,6 +2,10 @@ name: Build-and-publish-docker-images-workflow
 
 on:
   push:
+    branches:
+      - main
+      - staging
+      - development
 
   release:
     types: [published]
@@ -18,26 +22,36 @@ jobs:
           username: ${{ secrets.DOCKERHUB_USERNAME }}
           password: ${{ secrets.DOCKERHUB_TOKEN }}
 
+      - name: Set environment for branch
+        run: |
+          if [[ "${{github.base_ref}}" == "main" || "${{github.ref}}" == "refs/heads/main" ]]; then
+              echo "IMAGE_TAG=latest" >> "$GITHUB_ENV"
+          elif [[ "${{github.base_ref}}" == "staging" || "${{github.ref}}" == "refs/heads/staging" ]]; then
+            echo "IMAGE_TAG=staging" >> "$GITHUB_ENV"
+          else
+              echo "IMAGE_TAG=unstable" >> "$GITHUB_ENV"
+          fi
+
       - name: Build and push All in One image
         uses: docker/build-push-action@v5
         with:
           file: ./Dockerfile
           context: .
           push: true
-          tags: fraunhoferiosb/aasportal_aio:latest
+          tags: fraunhoferiosb/aasportal_aio:${{env.IMAGE_TAG}}
 
       - name: Build and push AASPortal (frontend) image
         uses: docker/build-push-action@v5
         with:
           file: ./Dockerfile.aas-portal
           context: .
           push: true
-          tags: fraunhoferiosb/aasportal_aasportal:latest
+          tags: fraunhoferiosb/aasportal_aasportal:${{env.IMAGE_TAG}}
 
       - name: Build and push AASServer (backend) image
         uses: docker/build-push-action@v5
         with:
           file: ./Dockerfile.aas-server
           context: .
           push: true
-          tags: fraunhoferiosb/aasportal_aasserver:latest
+          tags: fraunhoferiosb/aasportal_aasserver:${{env.IMAGE_TAG}}

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

@@ -0,0 +1,38 @@
+name: Build-and-test-workflow
+
+# This example workflow assumes that the default branch for your repository is `main`. If the default branch has a different name, edit this example and add your repository's default branch.
+on:
+  push:
+  pull_request:
+    types:
+      - opened
+
+#
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    # This job uses a matrix strategy to run the job four times, once for each specified Node version. For more information, see "[AUTOTITLE](/actions/using-jobs/using-a-matrix-for-your-jobs)."
+    strategy:
+      matrix:
+        node-version: [18.x]
+#
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: sudo apt update && sudo apt install chromium-browser && export CHROME_BIN='/usr/bin/chromium-browser'
+      - run: npm ci --unsafe-perm=true --allow-root
+      - run: npm run build -ws
+      - run: sudo npm run test
+      - run: npm run coverage
+      - name: Archive code coverage results
+        uses: actions/upload-artifact@v3
+        with:
+          name: code-coverage-report
+          path: |
+            reports/aas-portal.xml
+            reports/aas-server.xml
+            reports/common.xml

.github/workflows/versioning-workflow.yml

@@ -0,0 +1,34 @@
+name: Versioning-workflow
+on:
+  push:
+    branches:
+      - main
+      - staging
+      - development
+
+
+permissions:
+  contents: read # for checkout
+
+jobs:
+  release:
+    name: Versioning
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: "lts/*"
+      - name: Install dependencies
+        run: npm clean-install
+      - name: Verify the integrity of provenance attestations and registry signatures for installed dependencies
+        run: npm audit signatures
+      - name: Release
+        env:
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+        run: npx semantic-release

.gitignore

@@ -51,3 +51,4 @@ projects/aas-server/src/app/routes
 .DS_Store
 Thumbs.db
 .VSCodeCounter
+aas-server-config.json

.releaserc.yml

@@ -1,14 +1,11 @@
 {
-  "branches": ["main", "development"],
+  "branches": ["main", {"name": "development", "prerelease": true}, {"name": "staging", "prerelease": true}],
   "plugins": [
     "@semantic-release/commit-analyzer",
     "@semantic-release/release-notes-generator",
     ["@semantic-release/npm", {
       "npmPublish": false
     }],
-    ["@semantic-release/gitlab", {
-      "gitlabUrl": "https://gitlab.cc-asp.fraunhofer.de/"
-    }],
     ["@semantic-release/git", {
       "assets": ["package.json"],
       "message": "chore(Release): ${nextRelease.version}\n\n${nextRelease.notes}"

.vscode/launch.json

@@ -28,6 +28,7 @@
                 "CONTENT_ROOT": "projects/aas-server/build",
                 "WEB_ROOT": "projects/aas-portal/dist",
                 "ASSETS": "projects/aas-server/src/assets",
+                "USER_STORAGE": "mongodb://localhost:27017/aasportal-users",
                 "ENDPOINTS": "[\"file:///samples?name=Samples\"]"
             }
         },

CODE_OF_CONDUCT.md

@@ -12,7 +12,7 @@ and orientation.
 We pledge to act and interact in ways that contribute to an open, welcoming,
 diverse, inclusive, and healthy community.
 
-## Our Standards
+## Our Standardsbnm,
 
 Examples of behavior that contributes to a positive environment for our
 community include:

Dockerfile

@@ -2,7 +2,7 @@
 FROM node:lts-alpine3.16 as build
 WORKDIR /usr/src/app
 COPY . .
-RUN npm install -w=aas-server -w=aas-portal
+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
 
@@ -24,5 +24,4 @@ ENV ENDPOINTS=["\"file:///samples?name=Samples\""]
 ENV NODE_ENV=production
 
 EXPOSE 1337
-EXPOSE 1338
 CMD ["node", "aas-server.js" ]

README.md

@@ -3,23 +3,27 @@
 ![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. 
-
 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.1
-- Docker Desktop 4.x
+- GIT 2.36.0.windows
+- 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:
@@ -37,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: