From 230b3487fbdc5643d2a574886de02e522fcacda7 Mon Sep 17 00:00:00 2001 From: Awambeng Date: Tue, 5 Mar 2024 17:40:37 +0100 Subject: [PATCH 1/6] added: installation guide for tools needed to start the application and also how to run the different applications --- README.md | 114 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 113 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index a37bb313..b1cd99ad 100644 --- a/README.md +++ b/README.md @@ -1 +1,113 @@ -# e2e-banking-app \ No newline at end of file +# e2e-banking-app +Welcome to the e2e-banking-app project! This repository contains the code for the end-to-end banking application. + +## Prerequisites + +Before getting started,make sure you have the following tools installed: + +- [nvm (Node Version Manager)](https://github.com/nvm-sh/nvm): To manage Node.js versions. + +- [Node.js] (https://nodejs.org/): Javascript runtime environment. + +- [npm](https://www.npmjs.com/): Package manager for Node.js. + +- [sdkman](https://sdkman.io/): Software Development Kit Manager. + +- [Java](https://www.java.com/): Programming Language and runtime environment. + +-[Maven](https://maven.apache.org/): Build automation and dependency management tool. + +- [cargo](https://doc.rust-lang.org/cargo/): Package manager for Rust. + +## Installation + +Follow the steps below to set up the local environment: + +1. Install nvm: + - Visit the nvm Github repository: (https://github.com/nvm-sh/nvm) + - Follow the installation instructions for your operating system. + +2. Install Node.js and npm using nvm: + ``` bash + nvm install node + ``` + +3. Install sdkman: + - Visit the sdkman website: https://sdkman.io/ + - Follow the installation instructions for your operating system. + +4. Install Java and Maven using sdkman: + ``` bash + sdk install java + sdk install maven + ``` + +5. Install cargo: + - Visit the cargo website: https://www.rust-lang.org/tools/install + - Follow the installation instructions. + +# Getting Started + +To run the e2e-banking-app project locally, follow these steps: + +** 1. Clone the repository: ** + ``` bash + git clone https://github.com/ADORSYS-GIS/e2e-banking-app.git + ``` + +** 2. Change to the project directory: ** + ``` bash + cd e2e-banking-app + ``` + +** 3. Install project dependencies and Start application: ** + +a. For power-pay-front-end: + - Change to the project directory: + ``` bash + cd power-pay-frontend + ``` + - Install dependencies: + ``` bash + npm install + ``` + - Build the project: + ``` bash + npm run build + ``` + - Start application: + ``` bash + npm start + ``` + +b. For power-pay-backend: + - Change to the project directory: + ``` bash + cd power-pay-backend + ``` + - Install dependencies: + ``` bash + mvn install + ``` + - Build the project: + ``` bash + mvn clean package + ``` + - Start application: + ``` bash + java -jar target/power-pay-backend-0.0.1-SNAPSHOT.jar + ``` + +c. For power-pay-translator: + - Change to the project directory: + ``` bash + cd power-pay-translator + ``` + - Build the project: + ``` bash + cargo build + ``` + - Start application: + ``` bash + cargo run + ``` \ No newline at end of file From c0c17a1b654c324253122a1fb8bc05895ef65a90 Mon Sep 17 00:00:00 2001 From: Awambeng <114798938+Awambeng@users.noreply.github.com> Date: Tue, 5 Mar 2024 18:00:41 +0100 Subject: [PATCH 2/6] Update README.md --- README.md | 73 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 39 insertions(+), 34 deletions(-) diff --git a/README.md b/README.md index b1cd99ad..bbae0d07 100644 --- a/README.md +++ b/README.md @@ -50,64 +50,69 @@ Follow the steps below to set up the local environment: To run the e2e-banking-app project locally, follow these steps: -** 1. Clone the repository: ** +1. Clone the repository: ``` bash git clone https://github.com/ADORSYS-GIS/e2e-banking-app.git ``` -** 2. Change to the project directory: ** +2. Change to the project directory: ``` bash cd e2e-banking-app ``` -** 3. Install project dependencies and Start application: ** +3. Install project dependencies and Start application: -a. For power-pay-front-end: - - Change to the project directory: + a. For power-pay-front-end: + - Change to the project directory: ``` bash cd power-pay-frontend ``` - - Install dependencies: + - Install dependencies: ``` bash npm install ``` + - Build the project: ``` bash npm run build ``` + - Start application: ``` bash npm start ``` + b. For power-pay-backend: - - Change to the project directory: - ``` bash - cd power-pay-backend - ``` - - Install dependencies: - ``` bash - mvn install - ``` - - Build the project: - ``` bash - mvn clean package - ``` - - Start application: - ``` bash - java -jar target/power-pay-backend-0.0.1-SNAPSHOT.jar - ``` +- Change to the project directory: + ``` bash + cd power-pay-backend + ``` +- Install dependencies: + ``` bash + mvn install + ``` +- Build the project: + ``` bash + mvn clean package + ``` +- Start application: + ``` bash + java -jar target/power-pay-backend-0.0.1-SNAPSHOT.jar + ``` c. For power-pay-translator: - - Change to the project directory: - ``` bash - cd power-pay-translator - ``` - - Build the project: - ``` bash - cargo build - ``` - - Start application: - ``` bash - cargo run - ``` \ No newline at end of file +- Change to the project directory: + ``` bash + cd power-pay-translator + ``` + +- Build the project: + ``` bash + cargo build + ``` + +- Start application: + ``` bash + cargo run + ``` From 62018ce5884ae12a323774ec268dc506cce708e9 Mon Sep 17 00:00:00 2001 From: Awambeng <114798938+Awambeng@users.noreply.github.com> Date: Tue, 5 Mar 2024 18:01:15 +0100 Subject: [PATCH 3/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index bbae0d07..03ba2db8 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,7 @@ Before getting started,make sure you have the following tools installed: - [Java](https://www.java.com/): Programming Language and runtime environment. --[Maven](https://maven.apache.org/): Build automation and dependency management tool. +- [Maven](https://maven.apache.org/): Build automation and dependency management tool. - [cargo](https://doc.rust-lang.org/cargo/): Package manager for Rust. From 17afe423d8350b664e74f51f00be156c640af613 Mon Sep 17 00:00:00 2001 From: Awambeng <114798938+Awambeng@users.noreply.github.com> Date: Tue, 5 Mar 2024 18:02:05 +0100 Subject: [PATCH 4/6] Update README.md --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 03ba2db8..124f7a23 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ Before getting started,make sure you have the following tools installed: - [nvm (Node Version Manager)](https://github.com/nvm-sh/nvm): To manage Node.js versions. -- [Node.js] (https://nodejs.org/): Javascript runtime environment. +- [Node.js](https://nodejs.org/): Javascript runtime environment. - [npm](https://www.npmjs.com/): Package manager for Node.js. From bc7d56d15d37d7f5e5a16c1d89d66b2e98b99614 Mon Sep 17 00:00:00 2001 From: Awambeng Date: Wed, 6 Mar 2024 07:34:05 +0100 Subject: [PATCH 5/6] update: indent the README file so that it's well structured --- README.md | 124 ++++++++++++++++++++++++------------------------------ 1 file changed, 56 insertions(+), 68 deletions(-) diff --git a/README.md b/README.md index 124f7a23..9fbd8f80 100644 --- a/README.md +++ b/README.md @@ -3,20 +3,14 @@ Welcome to the e2e-banking-app project! This repository contains the code for th ## Prerequisites -Before getting started,make sure you have the following tools installed: +Before getting started, make sure you have the following tools installed: - [nvm (Node Version Manager)](https://github.com/nvm-sh/nvm): To manage Node.js versions. - - [Node.js](https://nodejs.org/): Javascript runtime environment. - - [npm](https://www.npmjs.com/): Package manager for Node.js. - - [sdkman](https://sdkman.io/): Software Development Kit Manager. - - [Java](https://www.java.com/): Programming Language and runtime environment. - - [Maven](https://maven.apache.org/): Build automation and dependency management tool. - - [cargo](https://doc.rust-lang.org/cargo/): Package manager for Rust. ## Installation @@ -24,95 +18,89 @@ Before getting started,make sure you have the following tools installed: Follow the steps below to set up the local environment: 1. Install nvm: - - Visit the nvm Github repository: (https://github.com/nvm-sh/nvm) - - Follow the installation instructions for your operating system. + - Visit the nvm Github repository: (https://github.com/nvm-sh/nvm) + - Follow the installation instructions for your operating system. 2. Install Node.js and npm using nvm: - ``` bash - nvm install node - ``` + ```bash + nvm install node + ``` 3. Install sdkman: - - Visit the sdkman website: https://sdkman.io/ - - Follow the installation instructions for your operating system. + - Visit the sdkman website: https://sdkman.io/ + - Follow the installation instructions for your operating system. 4. Install Java and Maven using sdkman: - ``` bash - sdk install java - sdk install maven - ``` + ```bash + sdk install java + sdk install maven + ``` 5. Install cargo: - - Visit the cargo website: https://www.rust-lang.org/tools/install - - Follow the installation instructions. + - Visit the cargo website: https://www.rust-lang.org/tools/install + - Follow the installation instructions. # Getting Started To run the e2e-banking-app project locally, follow these steps: 1. Clone the repository: - ``` bash - git clone https://github.com/ADORSYS-GIS/e2e-banking-app.git - ``` + ```bash + git clone https://github.com/ADORSYS-GIS/e2e-banking-app.git + ``` 2. Change to the project directory: - ``` bash - cd e2e-banking-app - ``` + ```bash + cd e2e-banking-app + ``` 3. Install project dependencies and Start application: - - a. For power-pay-front-end: - - Change to the project directory: - ``` bash - cd power-pay-frontend + a. For power-pay-front-end: + - Change to the project directory: + ```bash + cd power-pay-frontend ``` - - Install dependencies: - ``` bash - npm install + - Install dependencies: + ```bash + npm install ``` - - - Build the project: - ``` bash - npm run build + - Build the project: + ```bash + npm run build ``` - - - Start application: - ``` bash - npm start + - Start application: + ```bash + npm start ``` - -b. For power-pay-backend: -- Change to the project directory: - ``` bash + b. For power-pay-backend: + - Change to the project directory: + ```bash cd power-pay-backend - ``` -- Install dependencies: - ``` bash + ``` + - Install dependencies: + ```bash mvn install - ``` -- Build the project: - ``` bash + ``` + - Build the project: + ```bash mvn clean package - ``` -- Start application: - ``` bash + ``` + - Start application: + ```bash java -jar target/power-pay-backend-0.0.1-SNAPSHOT.jar - ``` + ``` -c. For power-pay-translator: -- Change to the project directory: - ``` bash + c. For power-pay-translator: + - Change to the project directory: + ```bash cd power-pay-translator - ``` - -- Build the project: - ``` bash + ``` + - Build the project: + ```bash cargo build - ``` - -- Start application: - ``` bash + ``` + - Start application: + ```bash cargo run - ``` + ``` \ No newline at end of file From 0d88e431f6948cd0ec4b93384cb2a50cd978a2ea Mon Sep 17 00:00:00 2001 From: Awambeng <114798938+Awambeng@users.noreply.github.com> Date: Wed, 6 Mar 2024 07:37:11 +0100 Subject: [PATCH 6/6] Update README.md --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9fbd8f80..849b231f 100644 --- a/README.md +++ b/README.md @@ -55,6 +55,7 @@ To run the e2e-banking-app project locally, follow these steps: ``` 3. Install project dependencies and Start application: + a. For power-pay-front-end: - Change to the project directory: ```bash @@ -103,4 +104,4 @@ To run the e2e-banking-app project locally, follow these steps: - Start application: ```bash cargo run - ``` \ No newline at end of file + ```