Skip to content
This repository has been archived by the owner on Dec 24, 2021. It is now read-only.

Latest commit

 

History

History
89 lines (56 loc) · 3.34 KB

local.md

File metadata and controls

89 lines (56 loc) · 3.34 KB
Raw

Run locally

This document shows how to run the watson-discovery-news application on your local machine.

Steps

  1. Clone the repo
  2. Create your Watson Discovery service
  3. Configure Watson Discovery
  4. Add Watson Discovery credentials
  5. Run the application

1. Clone the repo

Use the following command to clone the watson-discovery-news GitHub repository.

git clone https://github.com/ibm/watson-discovery-news

2. Create your Watson Discovery service

To create your Watson Discovery service:

  1. Click Create resource on your IBM Cloud dashboard.

  2. Search the catalog for Discovery.

  3. Click Discovery to launch the create panel.

create-service

  1. From the panel, enter a unique name, a region and resource group, and a plan type (select the default lite plan). Click Create to create and enable your service.

3. Configure Watson Discovery

The next step is to configure your Watson Discovery service.

  1. Find the Discovery service in your IBM Cloud Dashboard.
  2. Click on the service and then click Launch tool.

The Watson Discovery News data collection is already associated with your service. You'll use this collection as the data source for your app. To access the collection, you must find the COLLECTION_ID and ENVIRONMENT_ID. To find these values:

  1. Click on the collection from the Manage Data panel. In this case, it is named Watson Discovery News.
  2. Click on the drop-down icon located in the top right corner of the panel.

get-collection-id

Typically, these values need to be added to the application .env file (as shown in the next step), but in the case of Discovery News, the values are always news-en (though it might vary based on language) and system, so you do not need to specify them.

4. Add Watson Discovery credentials

Next, you'll need to add the Watson Discovery credentials to the .env file.

  1. From the home directory of your cloned local repo, create a .env file by copying it from the sample version.

cp env.sample .env
  1. Locate the service credentials listed on the home page of your Discovery service.

get-creds

  1. Copy and paste the apikey and URL values from your Watson Discovery service credentials into the .env file:
# Watson Discovery
DISCOVERY_URL=<add_discovery_url>
DISCOVERY_APIKEY=<add_discovery_iam_apikey>

5. Run the application

Finally, you'll run the application.

npm install
npm start

The application will be available in your browser at http://localhost:3000.

return