@ibm-watson/personality-insights-nodejs
v1.0.2
Published
A sample NodeJS app that uses the Personality Insights service
Downloads
8
Readme
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
- Sign up for an IBM Cloud account.
- Download the IBM Cloud CLI.
- 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 theusername
andpassword
values if your service instance doesn't provide anapikey
. - Copy the
url
value.
Configuring the application
In the application folder, copy the .env.example file and create a file called .env
cp .env.example .env
Open the .env file and add the service credentials that you obtained in the previous step.
Example .env file that configures the
apikey
andurl
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
andpassword
credentials, add thePERSONALITY_INSIGHTS_USERNAME
andPERSONALITY_INSIGHTS_PASSWORD
variables to the .env file.
Example .env file that configures the
username
,password
, andurl
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
- If your service instance uses
Setting Up the Twitter Application
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
- Update the
.env
file and add your twitter application credentials:
TWITTER_CONSUMER_KEY=<consumer-key>
TWITTER_CONSUMER_SECRET=<consumer-secret>
Running locally
Install the dependencies
npm install
Run the application
npm start
View the application in a browser at
localhost:3000
Deploying to IBM Cloud as a Cloud Foundry Application
Login to IBM Cloud with the IBM Cloud CLI
ibmcloud login
Target a Cloud Foundry organization and space.
ibmcloud target --cf
Edit the manifest.yml file. Change the name field to something unique.
For example,- name: my-app-name
.Deploy the application
ibmcloud app push
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.