Skip to content
This repository has been archived by the owner on Sep 19, 2018. It is now read-only.

Latest commit

 

History

History
206 lines (135 loc) · 7.73 KB

README.md

File metadata and controls

206 lines (135 loc) · 7.73 KB
Raw

Investment Insights for Asset Managers

Build Status

Investment Insights for Asset Managers is a Node.js application that uses IBM Financial services and Watson services.

The application is a modern portfolio manager that provides real-time insights into how news all around the world can impact any given investment portfolio.

Overview

The project deploys a node.js Cloud Foundry application and uses the following services:

architecture

The application uses the financial services to analyze a stock portfolio in regards to various risk factors. Risk factors include things like currency fluctuations or changes in the price of oil and gold.

flow

  1. User selects a risk factor to consider.
  2. Using Watson Discovery, the app looks for articles related to the risk factor.
  3. The app computes a shock value based on the sentiment of the articles.
  4. The app calls the Predictive Market Scenarios service to create conditional scenarios to model how, given a change to a subset of factors the broader set of market factors are expected to change.
  5. Finally it computes analytics on the portfolio stocks under the given scenarios.

Related Blog Posts, Videos, etc

Deploy to IBM Cloud using DevOps Toolchain

The app comes with a toolchain you can use to deploy the solution with few clicks. If you want to deploy it manually, you can skip this section.

  1. Ensure your organization has enough quota for one web application using 256MB of memory and 4 services.

  2. Click Deploy to IBM Cloud to start the IBM Cloud DevOps wizard:

    Deploy To IBM Cloud

  3. Select the GitHub box.

  4. Decide whether you want to fork/clone the app repository.

  5. If you decide to Clone, set a name for your GitHub repository.

  6. Select the Delivery Pipeline box.

  7. Select the region, organization and space where you want to deploy the app.

  8. Click Create.

  9. Select the Delivery Pipeline.

  10. Wait for the Deploy job to complete.

  11. Access the app when it's ready and start exploring.

Deploy to IBM Cloud manually

  1. If you do not already have an IBM Cloud account, [sign up here][bluemix_signup_url]

  2. Download and install the Cloud Foundry CLI tool

  3. Use this command to display or specify the URL of the API endpoint of Bluemix.

    cf api https://api.ng.bluemix.net

  4. Connect to IBM Cloud in the command line tool and follow the prompts to log in

    cf login -a https://api.ng.bluemix.net

  5. Clone the app to your local environment from your terminal using the following command:

    git clone https://github.com/IBM-Cloud/investment-insights-for-asset-managers.git

  6. cd into this newly created directory

  7. Navigate to manifest.yml file and change the NAME "investment-insights-for-sset-managers" to an unique name of your choice. The new name is your APP_NAME in the commands below.

  8. Follow the above step for SERVICES as well.

  9. Create services required for this app

  10. Run the shell script "run.sh" to create the services in one go.

    1. Make your shell script executable by running this command
      chmod +x script.sh
    1. Copy the shell file to /usr/local/bin with the below command
     cp script.sh /usr/local/bin

    On the terminal. just run the script.sh.

    OR

    Manually create services

    cf create-service discovery lite <Discovery_Service_Name>

    Discovery Service Name as mentioned in manifest.yml above

    cf create-service fss-portfolio-service fss-portfolio-service-free-plan <Portfolio_Service_Name as in manifest.yml>

    cf create-service fss-predictive-scenario-analytics-service fss-predictive-scenario-analytics-service-free-plan <Predictive_Scenario_Name as in manifest.yml>

    cf create-service fss-scenario-analytics-service  fss-scenario-analytics-service-free-plan <Scenario_Analytics_Name as in manifest.yml>

    cf create-service AppID "Graduated tier" <AppID name as in manifest.yml>

  11. Push the app to IBM Cloud

    cf push

    This command uses the manifest.yml file in your directory to CREATE the app and BIND the services to the app

And voila! You now have your very own application running on IBM Cloud.

Run the app locally

  1. If you do not already have an IBM Cloud account, [sign up here][bluemix_signup_url]

  2. If you have not already, download Node.js and install it on your local machine.

  3. In the checkout directory, create a file .env and paste the below snippet

INVESTMENT_PORFOLIO_BASE_URL=investment-portfolio.mybluemix.net
INVESTMENT_PORFOLIO_USERNAME=
INVESTMENT_PORFOLIO_PASSWORD=

DISCOVERY_USERNAME=
DISCOVERY_PASSWORD=

PREDICTIVE_MARKET_SCENARIOS_URI=fss-analytics.mybluemix.net
PREDICTIVE_MARKET_SCENARIOS_ACCESS_TOKEN=

SIMULATED_INSTRUMENT_ANALYSIS_URI=fss-analytics.mybluemix.net
SIMULATED_INSTRUMENT_ANALYSIS_ACCESS_TOKEN=

  APPID_TENANTID=fab34d0b-a061-4e3e-af99-624efa8752b8
  APPID_CLIENTID=f09de90a-17fd-4f76-8e09-723b860c27f3
  APPID_SECRET=OTEyMjIwYWYtMTIzNS00OGQ4LTg4NjItZWQwMjIzZTZhZDUz
  APPID_OAUTHSERVERURL=

  1. For credentials and access tokens, run this command

    cf env APP_NAME

  2. Run

    npm install

  3. Run

    npm start

Contribute

If you find a bug, please report it via the [Issues section][issues_url] or even better, fork the project and submit a pull request with your fix! We are more than happy to accept external contributions to this project if they address something noted in an existing issue. In order to be considered, pull requests must pass the initial Travis CI build and/or add substantial value to the sample application.

Troubleshooting

The primary source of debugging information for your IBM Cloud app is the logs. To see them, run the following command using the Cloud Foundry CLI:

$ cf logs APP_NAME --recent

For more detailed information on troubleshooting your application, see the Troubleshooting section in the IBM Cloud documentation.

License

See License.txt for license information.