πŸ“Š Sample Nodejs Application for the IBM Watson Personality Insights Service
JavaScript CSS HTML
Clone or download

README.md

πŸš€ Personality Insights Sample Application

This Node.js app demonstrates how to analyze text and tweets using Personality Insights.

Travis semantic-release

The IBM Watson Personality Insights service uses linguistic analysis to extract cognitive and social characteristics from input text such as email, text messages, tweets, forum posts, and more. By deriving cognitive and social preferences, the service helps users to understand, connect to, and communicate with other people on a more personalized level.

Prerequisites

  1. Sign up for an IBM Cloud account.
  2. Download the IBM Cloud CLI.
  3. Create an instance of the Personality Insights service and get your credentials:
    • Go to the Personality Insights 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 Personality Insights service instance hosted in the US East region:

    PERSONALITY_INSIGHTS_IAM_APIKEY=X4rbi8vwZmKpXfowaS3GAsA7vdy17Qh7km5D6EzKLHL2
    PERSONALITY_INSIGHTS_URL=https://gateway-wdc.watsonplatform.net/personality-insights/api
    
    • If your service instance uses username and password credentials, add the PERSONALITY_INSIGHTS_USERNAME and PERSONALITY_INSIGHTS_PASSWORD variables to the .env file.

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

    PERSONALITY_INSIGHTS_USERNAME=522be-7b41-ab44-dec3-g1eab2ha73c6
    PERSONALITY_INSIGHTS_PASSWORD=A4Z5BdGENrwu8
    PERSONALITY_INSIGHTS_URL=https://gateway-syd.watsonplatform.net/personality-insights/api
    

Setting Up the Twitter Application

  1. [Create a Twitter application][create_twitter_app].

  2. Add your application's callback URL:

  • For Bluemix environment: <application-name>.mybluemix.net/auth/twitter/callback
  • For Local environment: http://localhost:3000/auth/twitter/callback
  1. Update the .env file and add your twitter application credentials:
TWITTER_CONSUMER_KEY=<consumer-key>
TWITTER_CONSUMER_SECRET=<consumer-secret>

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 entry point
β”œβ”€β”€ config                       // express configuration
β”‚Β Β  β”œβ”€β”€ error-handler.js
β”‚Β Β  β”œβ”€β”€ express.js
β”‚Β Β  β”œβ”€β”€ i18n.js
β”‚Β Β  β”œβ”€β”€ passport.js
β”‚Β Β  └── security.js
β”œβ”€β”€ helpers                      // utility modules
β”‚Β Β  β”œβ”€β”€ personality-insights.js
β”‚Β Β  └── twitter-helper.js
β”œβ”€β”€ i18n                         // internationalization
β”‚Β Β  β”œβ”€β”€ en.json
β”‚Β Β  β”œβ”€β”€ es.json
β”‚Β Β  └── ja.json
β”œβ”€β”€ manifest.yml
β”œβ”€β”€ package.json
β”œβ”€β”€ public
β”‚Β Β  β”œβ”€β”€ css
β”‚Β Β  β”œβ”€β”€ data                     // sample text and tweets
β”‚Β Β  β”œβ”€β”€ fonts
β”‚Β Β  β”œβ”€β”€ images
β”‚Β Β  └── js
β”œβ”€β”€ router.js                   // express routes
β”œβ”€β”€ server.js                   // application entry point
β”œβ”€β”€ test
└── views                       // ejs views

License

This sample code is licensed under Apache 2.0.
Full license text is available in LICENSE.

Contributing

See CONTRIBUTING.

Open Source @ IBM

Find more open source projects on the IBM Github Page.