@ibm-watson/customer-engagement-nodejs

🚀 Customer Engagement Demo

This application demonstrates how the Watson Tone Analyzer service can be used for Customer Engagement.

Prerequisites

1. Sign up for an IBM Cloud account.
2. Download the IBM Cloud CLI.
3. Create an instance of the Tone Analyzer service and get your credentials:
   • Go to the Tone Analyzer page in the IBM Cloud Catalog.
   • Log in to your IBM Cloud account.
   • Click Create.
   • Click Show to view the service credentials.
   • Copy the apikey value, or copy the username and password values if your service instance doesn't provide an apikey.
   • Copy the url value.

Configuring the application

1. In the application folder, copy the .env.example file and create a file called .env

   cp .env.example .env
   

2. Open the .env file and add the service credentials that you obtained in the previous step.

   Example .env file that configures the apikey and url for a Tone Analyzer service instance hosted in the US East region:

   TONE_ANALYZER_IAM_APIKEY=X4rbi8vwZmKpXfowaS3GAsA7vdy17Qh7km5D6EzKLHL2
   TONE_ANALYZER_URL=https://gateway.watsonplatform.net/tone-analyzer/api
   

   • If your service instance uses username and password credentials, add the TONE_ANALYZER_USERNAME and TONE_ANALYZER_PASSWORD variables to the .env file.

   Example .env file that configures the username, password, and url for a Tone Analyzer service instance hosted in the Sydney region:

   TONE_ANALYZER_USERNAME=522be-7b41-ab44-dec3-g1eab2ha73c6
   TONE_ANALYZER_PASSWORD=A4Z5BdGENrwu8
   TONE_ANALYZER_URL=https://gateway-syd.watsonplatform.net/tone-analyzer/api
   

Running locally

1. Install the dependencies

   npm install
   

2. Run the application

   npm start
   

3. View the application in a browser at localhost:3000

Deploying to IBM Cloud as a Cloud Foundry Application

1. Login to IBM Cloud with the IBM Cloud CLI

   ibmcloud login
   

2. Target a Cloud Foundry organization and space.

   ibmcloud target --cf
   

3. Edit the manifest.yml file. Change the name field to something unique.
   For example, - name: my-app-name.

4. Deploy the application

   ibmcloud app push
   

5. View the application online at the app URL.
   For example: https://my-app-name.mybluemix.net

---

Directory structure

.
├── app.js                      // express routes
├── config                      // express configuration
│   ├── error-handler.js
│   ├── express.js
│   └── security.js
├── manifest.yml
├── package.json
├── public                      // static resources
├── server.js                   // entry point
├── test                        // unit tests
└── views                       // react components

License

This sample code is licensed under Apache 2.0.

Contributing

See CONTRIBUTING.

Open Source @ IBM

Find more open source projects on the IBM Github Page