diff --git a/README.md b/README.md index 9bd8b877..3705de1a 100644 --- a/README.md +++ b/README.md @@ -1 +1,67 @@ -Please refer to the official documentation [here](https://ob.docs.wso2.com/en/latest/) + + +# WSO2 Open Banking Accelerator + +[Open Banking Accelerator](https://ob.docs.wso2.com/en/latest/) a collection of technologies that increases the speed and reduces the complexity of adopting open banking compliance. + +### Building from the source + +If you want to build Open Banking Accelerator from the source code: + +1. Install Java8 or above. +1. Install [Apache Maven 3.0.5](https://maven.apache.org/download.cgi) or above. +1. To get the Open Banking Accelerator from [this repository](https://github.com/wso2/financial-services-accelerator.git), click **Clone or download**. + * To **clone the solution**, copy the URL and execute the following command in a command prompt. + `git clone `. After cloning, checkout to the **3.0.0** branch. + * To **download the pack**, select the branch **3.0.0** first, then click **Download ZIP** and unzip the downloaded file. +1. Navigate to the downloaded solution using a command prompt and run the Maven command. + + | Command | Description | + | :--- |:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| + | ```mvn install``` | This starts building the pack without cleaning the folders. | + | ```mvn clean install``` | This cleans the folders and starts building the solution pack from scratch. | + | ```mvn clean install -P solution``` | This cleans the folders and starts building the solution pack from scratch. Finally creates the accelerator zip files containing the artifacts required to setup the deployment. | + +1. Once the build is created, navigate to the relevant folder to get the accelerator for each product. + +| Product | Toolkit Path | + |:----------------------------------------|:--------------------------------------------------------| +| ```Identity Server Accelerator``` | `/open-banking-accelerator/accelerators/ob-is/target` | +| ```API Manager Accelerator``` | `/open-banking-accelerator/accelerators/ob-apim/target` | +| ```Business Intelligence Accelerator``` | `/open-banking-accelerator/accelerators/ob-bi/target` | + + +### Installing and Running OB Accelerators + +Please refer the following READ.ME files to run the products. + +| Product | Instructions Path | +|:-----------------------------------------------|:------------------------------------------| +| ```Identity Server Accelerator``` | `/wso2-obiam-accelerator-3.0.0/README.md` | +| ```API Manager Accelerator``` | `/wso2-obam-accelerator-3.0.0/README.md` | +| ```Business Intelligence Server Accelerator``` | `/wso2-obbi-accelerator-3.0.0/README.md` | + + +### Reporting Issues + +We encourage you to report issues, documentation faults, and feature requests regarding the Open Banking Accelerator through the [WSO2 Open Banking Accelerator Issue Tracker](https://github.com/wso2/financial-services-accelerator/issues). + +### License + +This source is licensed under the Apache License Version 2.0 ([LICENSE](LICENSE)).