diff --git a/README.md b/README.md index 124f7a23..ae10a0a6 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,90 @@ 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