Skip to content

Commit

Permalink
Merge pull request #28 from eclipse-mnestix/dev
Browse files Browse the repository at this point in the history
Dev to Staging
  • Loading branch information
GailMelanie authored Dec 9, 2024
2 parents 1a0f639 + 8dfa85d commit 9d7b5f4
Show file tree
Hide file tree
Showing 121 changed files with 7,496 additions and 2,719 deletions.
6 changes: 5 additions & 1 deletion .env.local
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ APPLICATION_ID_URI: 'api://mnestix-test-web-api/'
LOCK_TIMESERIES_PERIOD_FEATURE_FLAG: true
COMPARISON_FEATURE_FLAG: true
AAS_LIST_FEATURE_FLAG: true
AAS_LIST_V2_FEATURE_FLAG: false
TRANSFER_FEATURE_FLAG: false
AAS_REPO_API_URL: 'http://localhost:5064/repo'
SUBMODEL_REPO_API_URL: 'http://localhost:5064/repo'
Expand All @@ -23,4 +24,7 @@ KEYCLOAK_CLIENT_ID: "mnestix-browser-client-demo"
KEYCLOAK_LOCAL_URL: ""
KEYCLOAK_REALM: "BaSyx"
KEYCLOAK_ISSUER: "http://localhost:8080"
NEXTAUTH_URL: http://localhost:3000
NEXTAUTH_URL: http://localhost:3000

IMPRINT_URL:
DATA_PRIVACY_URL:
18 changes: 10 additions & 8 deletions .github/workflows/autoAddReviewer.yaml
Original file line number Diff line number Diff line change
@@ -1,15 +1,17 @@
name: Auto Add Reviewer

on:
on:
pull_request:
types: [opened]
types: [ opened ]

jobs:
build:
permissions:
pull-requests: write
runs-on: ubuntu-latest
steps:
- name: Add Reviewers
uses: madrapps/add-reviewers@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
reviewers: GailMelanie,hofermo,JonathanXITASO,pawel-baran-se,XAlinaGS,Xmilofranke,NilsXitaso,FranzXitaso,XAndreJentzsch,fleanegan
- name: Add Reviewers
uses: madrapps/add-reviewers@v1
with:
token: ${{ secrets.GITHUB_TOKEN }}
reviewers: GailMelanie,hofermo,JonathanXITASO,pawel-baran-se,XAlinaGS,Xmilofranke,NilsXitaso
15 changes: 5 additions & 10 deletions .github/workflows/docker-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,9 @@ env:
IMAGE_NAME: mnestix-browser
IMAGE_TAG: latest
# Update the version manually
IMAGE_TAG_VERSION: 1.3.0
AD_CLIENT_ID: ${{ secrets.AD_CLIENT_ID }}
AD_TENANT_ID: ${{ secrets.AD_TENANT_ID }}
REGISTRY_USER: ${{ vars.REGISTRY_USER }}
REGISTRY_PASS: ${{ secrets.REGISTRY_PASS }}
AZURE_REGISTRY_PASS: ${{ secrets.AZURE_REGISTRY_PASS }}
AZURE_REGISTRY_USER: ${{ vars.AZURE_REGISTRY_USER }}
IMAGE_TAG_VERSION: 1.3.1
REGISTRY_USER: ${{ secrets.DOCKER_USERNAME }}
REGISTRY_PASS: ${{ secrets.DOCKER_API_TOKEN }}

jobs:
default:
Expand Down Expand Up @@ -79,6 +75,5 @@ jobs:
if: github.ref == 'refs/heads/dev' || github.ref == 'refs/heads/staging'
env:
BRANCH_NAME: ${{ steps.extract_branch.outputs.branch }}
run: docker tag mnestix/$IMAGE_NAME mnestixcr.azurecr.io/$IMAGE_NAME:$BRANCH_NAME &&
docker login -u $AZURE_REGISTRY_USER -p $AZURE_REGISTRY_PASS mnestixcr.azurecr.io &&
docker push mnestixcr.azurecr.io/$IMAGE_NAME:$BRANCH_NAME
run: docker tag mnestix/$IMAGE_NAME mnestix/$IMAGE_NAME:$BRANCH_NAME &&
docker push mnestix/$IMAGE_NAME:$BRANCH_NAME
4 changes: 2 additions & 2 deletions .idea/codeStyles/Project.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

38 changes: 29 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
<img width="20%" src="src/assets/XitasoLogoBlack.svg" alt="XITASO Logo">
<p style="text-align: center">
<img src="public/android-chrome-192x192.png" alt="Mnestix Logo">
<p align="right">
<picture>
<source srcset="src/assets/XitasoLogo.svg" media="(prefers-color-scheme: dark)">
<img src="src/assets/XitasoLogoBlack.svg" width=20%>
</picture>
</p>
<p align="center">
<img src="public/android-chrome-192x192.png" alt="Mnestix Logo">
</p>
<h1 style="text-align: center">Mnestix</h1>

[![Made by XITASO](https://img.shields.io/badge/Made_by_XITASO-005962?style=flat-square)](https://xitaso.com/)
[![MIT License](https://img.shields.io/badge/License-MIT-005962.svg?style=flat-square)](https://choosealicense.com/licenses/mit/)
[![Yarn License](https://img.shields.io/badge/YARN-V1.22.22-005962?style=flat-square)]()
[![Join our Community](https://img.shields.io/badge/Join_our_Community-005962?style=flat-square)](https://mnestix.io/)
[![Join our Community](https://img.shields.io/badge/Join_our_Community-005962?style=flat-square)](https://xitaso.com/kompetenzen/mnestix/#support)

### Welcome to the Mnestix Community!

Expand All @@ -22,7 +27,7 @@ implementation of standardized digital twins. It opens the way for use cases suc
You can find a demo [here](https://mnestix-prod.azurewebsites.net/).
Some screenshots can be found in the [screenshots folder](screenshots).

### **If you need support feel free to contact us through our website [Mnestix.io](https://mnestix.io/).**
### **If you need support feel free to contact us through our website [here](https://xitaso.com/kompetenzen/mnestix/#support).**

## Quickstart

Expand Down Expand Up @@ -276,6 +281,7 @@ Mnestix provides the following configuration options. You can adapt the values i
| `SUBMODEL_REPO_API_URL` | | Default Submodel Repository to display when Submodel Id is not in Submodel Registry | required |
| `MNESTIX_BACKEND_API_URL` | | Mnestix Backend with a lot of business comfort features like the Repository-Proxy or the Template builder | optional |
| `AAS_LIST_FEATURE_FLAG` | false | Enables or disables the AasList in the frontend. This only works in combination with `Features__AllowRetrievingAllShellsAndSubmodels` being set to `true` (Needs the Mnestix Backend to work) | optional |
| `AAS_LIST_V2_FEATURE_FLAG` | false | The functionality controlled by this flag is under active development and may change without notice. Please see [details](#aas-list-v2-feature-details) | optional |
| `TRANSFER_FEATURE_FLAG` | false | Enables or disables the Transfer Feature in the frontend. If enabled, it is possible to import a viewed AAS to a configured repository. This feature is currently being developed. | optional |
| `AUTHENTICATION_FEATURE_FLAG` | false | Enable or disable the authentication in the frontend. (Needs the Mnestix Backend to work) | optional |
| `COMPARISON_FEATURE_FLAG` | false | Enables or disables the comparison feature. | optional |
Expand All @@ -289,6 +295,8 @@ Mnestix provides the following configuration options. You can adapt the values i
| `KEYCLOAK_ISSUER` | | Configuration variable that specifies the URL of the Keycloak servers issuer endpoint. This endpoint provides the base URL for the Keycloak server that issues tokens and handles authentication requests | optional |
| `KEYCLOAK_LOCAL_URL` | | Optional configuration variable specifically used for development environments within Docker. This allows your application to connect to a Keycloak instance running in a Docker container | optional |
| `KEYCLOAK_REALM` | BaSyx | Configuration variable that specifies the name of the Keycloak realm your application will use for authentication and authorization. | optional |
| `IMPRINT_URL` | | Address that will be used in the imprint link. Will only show the link, if a value has been set. | optional |
| `DATA_PRIVACY_URL` | | Address that will be used in the data privacy link. Will only show the link, if a value has been set. | optional |

### How to set a custom logo

Expand Down Expand Up @@ -543,6 +551,18 @@ backend environment variable `Features__AllowRetrievingAllShellsAndSubmodels: fa
Remember that this also means that the functionality to list all AAS won't work anymore in the Mnestix Browser, so
disable this functionality with the environment variable `AAS_LIST_FEATURE_FLAG: false`.

#### AAS List V2 Feature Details

The `AAS_LIST_V2_FEATURE_FLAG` is a feature flag introduced as part of a preview release.
It enables access to an updated list implementation that operates independently of the Mnestix API.

This flag is currently disabled by default (false) and is available only in preview.
It is not yet recommended for production environments.

To enable the feature for testing or preview purposes, set the flag to true in your configuration.

#### AzureAD Service

One can also add an AzureAD Service to give people deeper access, this enables the "Login" Button in the Mnestix
Browser.
After logging in, users have access to even more functionality.
Expand Down Expand Up @@ -707,7 +727,7 @@ Right now, we are building a community around Mnestix.
If you are looking for a way to support us, you can start contributing to Mnestix right away.
For this purpose, issues which are particularly suitable for a first contribution are labeled with the tag
`good first issue`.
If this is your first time contributing to a github project, we recommend having a look at this
guide: [Contributing to a project](https://docs.github.com/en/get-started/exploring-projects-on-github/contributing-to-a-project).
We would be more than happy to have you onboard. If there is anything you want to know, feel free to contact
us [mnestix@xitaso.com](mailto:mnestix@xitaso.com).
If this is your first time contributing to an eclipse project, we recommend having a look at this
guide: [Contributing to a Eclipse project](https://www.eclipse.org/contribute/).
We would be more than happy to have you on board. If there is anything you want to know, feel free to contact
us [mnestix@xitaso.com](mailto:mnestix@xitaso.com) or through our website [here](https://xitaso.com/kompetenzen/mnestix/#support).
7 changes: 7 additions & 0 deletions __mocks__/svg.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
import { forwardRef, SVGProps } from 'react';

// eslint-disable-next-line react/display-name
const SvgrMock = forwardRef<SVGSVGElement, SVGProps<SVGSVGElement>>((props, ref) => <svg ref={ref} {...props} />);

export const ReactComponent = SvgrMock;
export default SvgrMock;
5 changes: 4 additions & 1 deletion compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,14 @@ services:
SUBMODEL_REPO_API_URL: 'http://mnestix-api:5064/repo'
MNESTIX_BACKEND_API_URL: 'http://mnestix-api:5064'
AAS_LIST_FEATURE_FLAG: "true"
AAS_LIST_V2_FEATURE_FLAG: "false"
TRANSFER_FEATURE_FLAG: "false"
COMPARISON_FEATURE_FLAG: "true"
AUTHENTICATION_FEATURE_FLAG: "false"
LOCK_TIMESERIES_PERIOD_FEATURE_FLAG: "true"
NEXTAUTH_SECRET: ${NEXTAUTH_SECRET:-verySecureNextAuthSecret}
IMPRINT_URL: ""
DATA_PRIVACY_URL: ""
depends_on:
aas-environment:
condition: service_healthy # only after the healthcheck in aas is successful, the mnestix container is being created
Expand All @@ -38,7 +41,7 @@ services:
- mnestix-database:/app/prisma/database

mnestix-api:
image: mnestix/mnestix-api:1.2.3
image: mnestix/mnestix-api:1.2.4
container_name: mnestix-api
profiles: [ "", "backend", "tests" ]
ports:
Expand Down
2 changes: 2 additions & 0 deletions global.d.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
import '@testing-library/jest-dom/extend-expect';
import '@testing-library/jest-dom/jest-globals'
Loading

0 comments on commit 9d7b5f4

Please sign in to comment.