From e3e35299de3b1ffa9012ccfd640dea5b1599161f Mon Sep 17 00:00:00 2001 From: "fabio.d.mota" Date: Mon, 19 Feb 2024 17:20:01 +0000 Subject: [PATCH] doc(frontend): Update Readme.md and Install.md --- CHANGELOG.md | 1 + INSTALL.md | 6 +++--- README.md | 16 ++-------------- 3 files changed, 6 insertions(+), 17 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 163339c5..18366aac 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -15,6 +15,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Changed - Updated arc42 documentation to align with the EDC updated Country Risk application. +- Update Readme.md and Install.md ### Added - Added Error Page for when user is with right credentials but not subscribed to the App diff --git a/INSTALL.md b/INSTALL.md index 93c188c9..ada53b8e 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -11,13 +11,13 @@ This project is a Frontend web application for the value added services project Clone the source locally: ```sh -git clone "URL-OF-PROJECT" -cd product-vas-country-risk-frontend +git clone https://github.com/eclipse-tractusx/vas-country-risk.git +cd vas-country-risk ``` To run with the APIs of the local backend part of the project, you need to change the APIs URLs on the .env file! -Do the following command `npm install @emotion/react @emotion/styled @mui/icons-material@5.10.6 @mui/material@5.10.7 react-simple-maps cx-portal-shared-components react-scripts` +Do the following command `npm install` to install the application. After that the application should be run with diff --git a/README.md b/README.md index 8907920c..4929867b 100644 --- a/README.md +++ b/README.md @@ -30,21 +30,9 @@ There are two demo environments provided by Catena-X: * Components: https://portal.dev.demo.catena-x.net/_storybook/ # Getting Started and How to run locally -Clone the source locally: +You can follow our installation guides to install and run our application: -```sh -git clone "URL-OF-PROJECT" -cd product-vas-country-risk-frontend -``` - -To run with the APIs of the local backend part of the project, you need to change the APIs URLs on the .env file! - -Do the following command `npm install @emotion/react @emotion/styled @mui/icons-material@5.10.6 @mui/material@5.10.7 react-simple-maps cx-portal-shared-components react-scripts` -to install the application. - -After that the application should be run with -the `npm start` command. -This will run the application on the following URL: [http://localhost:3000](http://localhost:3000) +* [Install Vas Country Risk](./INSTALL.md) ## Notice for Docker image