From e012c4ade0bf698763fed7881e7b5582c186614c Mon Sep 17 00:00:00 2001 From: Evelyn Gurschler Date: Fri, 1 Mar 2024 12:09:11 +0100 Subject: [PATCH 1/2] docs: add notice footer https://github.com/eclipse-tractusx/portal-frontend/issues/567 --- FILEHEADER.md | 8 ++++++++ scripts/check-dependencies.md | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/FILEHEADER.md b/FILEHEADER.md index b5ca5b836..edd5de4b6 100644 --- a/FILEHEADER.md +++ b/FILEHEADER.md @@ -14,3 +14,11 @@ Currently the following templates are available: - cx_header_default - cx*header_with*# + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets diff --git a/scripts/check-dependencies.md b/scripts/check-dependencies.md index 439139030..2c0ecf2af 100644 --- a/scripts/check-dependencies.md +++ b/scripts/check-dependencies.md @@ -7,3 +7,11 @@ This workflow uses the executable jar in the download directory. In order to update the executable jar run the following command from the root directory: curl -L --output ./scripts/download/org.eclipse.dash.licenses-1.0.2.jar 'https://repo.eclipse.org/service/local/artifact/maven/redirect?r=dash-licenses&g=org.eclipse.dash&a=org.eclipse.dash.licenses&v=1.0.2' + +## NOTICE + +This work is licensed under the [Apache-2.0](https://www.apache.org/licenses/LICENSE-2.0). + +- SPDX-License-Identifier: Apache-2.0 +- SPDX-FileCopyrightText: 2021-2024 Contributors to the Eclipse Foundation +- Source URL: https://github.com/eclipse-tractusx/portal-assets From bd1975115ba44d04faa764196fcc0f3429d90dfc Mon Sep 17 00:00:00 2001 From: Evelyn Gurschler Date: Fri, 1 Mar 2024 12:19:40 +0100 Subject: [PATCH 2/2] chore: update readme with suggestions from quality gate ref: https://github.com/eclipse-tractusx/portal-frontend/issues/564 https://github.com/eclipse-tractusx/portal-assets/issues/272 https://github.com/eclipse-tractusx/portal-frontend/issues/562 --- README.md | 53 +++++++++++++++++++++++++++++++++++------------------ 1 file changed, 35 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 96bdadd32..42b0eb259 100644 --- a/README.md +++ b/README.md @@ -1,43 +1,60 @@ -# Catena-X Portal Assets +[![LeadingRepository](https://img.shields.io/badge/Leading_Repository-Portal-blue)](https://github.com/eclipse-tractusx/portal) -This repository contains the documentation and static image content for Catena-X Portal. +# Portal Assets -The Catena-X Portal application consists of +This repository contains the documentation and static image content for Portal. + +The Portal application consists of - [portal-frontend](https://github.com/eclipse-tractusx/portal-frontend), - [portal-frontend-registration](https://github.com/eclipse-tractusx/portal-frontend-registration), - [portal-assets](https://github.com/eclipse-tractusx/portal-assets) and - [portal-backend](https://github.com/eclipse-tractusx/portal-backend). -![Tag](https://img.shields.io/static/v1?label=&message=LeadingRepository&color=green&style=flat) The helm chart for installing the Catena-X Portal is available in the [portal](https://github.com/eclipse-tractusx/portal) repository. +The helm chart for installing the Portal is available in the [portal](https://github.com/eclipse-tractusx/portal) repository. + +Please refer to the [docs](./docs/) directory for the overarching user and developer documentation of the Portal application. + +The Portal is designed to work with the [IAM](https://github.com/eclipse-tractusx/portal-iam). + +## Local build and run + +1. Install dependencies + +``` +yarn +``` -The Catena-X Portal is designed to work with the [Catena-X IAM](https://github.com/eclipse-tractusx/portal-iam) for further information you can read the [documentation](https://github.com/eclipse-tractusx/portal-iam/tree/main/docs). +3. Build release for documentation app -## Steps to run local +``` +yarn build:release +``` - yarn - yarn build:release - yarn build - yarn start +3. Build + +``` +yarn build +``` + +4. Run + +``` +yarn start +``` This will start the assets and documentation on - https://localhost:3003/assets/ - https://localhost:3003/documentation/ -Note: if you'd like to run the complete frontend application, follow the 'Run frontend on localhost' guide within the developer documentation which is available within this repository. +Note: if you'd like to run the complete frontend application, follow the `Run frontend on localhost.md` guide within the developer documentation which is available within this repository. ## Notice for Docker image This application provides container images for demonstration purposes. -DockerHub: https://hub.docker.com/r/tractusx/portal-assets - -Base image: nginxinc/nginx-unprivileged:alpine - -- Dockerfile: [nginxinc/nginx-unprivileged:alpine](https://github.com/nginxinc/docker-nginx-unprivileged/blob/main/Dockerfile-alpine.template) -- GitHub project: [https://github.com/nginxinc/docker-nginx-unprivileged](https://github.com/nginxinc/docker-nginx-unprivileged) -- DockerHub: [https://hub.docker.com/r/nginxinc/nginx-unprivileged](https://hub.docker.com/r/nginxinc/nginx-unprivileged) +See [Docker notice](.conf/notice-assets.md) for more information. ## License