mediapreneur / alchemylanguage-nodejs

Alchemy Language Node.js Sample Application

AlchemyLanguage Demo

AlchemyLanguage is a collection of APIs that offer text analysis through natural language processing. The AlchemyLanguage APIs can analyze text and help you to understand its sentiment, keywords, entities, high-level concepts and more.

Give it a try! Click the button below to fork into IBM DevOps Services and deploy your own copy of this application on Bluemix.

Note: The automatic Deploy to Bluemix process may fail if you already have a free AlchemyAPI instance on your account. In that case, please follow the manual steps below.

Getting started

1. You need a Bluemix account. If you don't have one, sign up. Experimental Watson Services are free to use.

2. Download and install the Cloud-foundry CLI tool if you haven't already.

3. Edit the manifest.yml file and change <application-name> to something unique. The name you use determines the URL of your application. For example, <application-name>.mybluemix.net.

applications:
- services:
  - alchemy-service
  name: <application-name>
  command: npm start
  path: .
  memory: 512M

1. Connect to Bluemix with the command line tool.

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

1. Create and retrieve service keys to access the AlchemyLanguage service:

cf create-service alchemy_api standard alchemy-service
cf create-service-key alchemy-service myKey
cf service-key alchemy-service myKey

Note: on Bluemix Trial accounts, you'll need to use the free plan instead:

cf create-service alchemy_api free alchemy-service

Bluemix accounts are limited to a single free alchemy_api service instance; if you already have one, then edit your use that api_key in the next step.

1. Create a .env file in the root directory by copying the sample .env.example file using the following command:

cp .env.example .env

You will update the .env with the information you retrieved in steps 5

The .env file will look something like the following:

ALCHEMY_LANGUAGE_API_KEY=

1. Install the dependencies you application need:

npm install

1. Start the application locally:

npm start

1. Point your browser to http://localhost:3000.

2. Optional: Push the application to Bluemix:

cf push

After completing the steps above, you are ready to test your application. Start a browser and enter the URL of your application.

        <your application name>.mybluemix.net

For more details about developing applications that use Watson Developer Cloud services in Bluemix, see Getting started with Watson Developer Cloud and Bluemix.

Troubleshooting

• The main source of troubleshooting and recovery information is the Bluemix log. To view the log, run the following command:

  cf logs <application-name> --recent

• For more details about the service, see the [documentation][nlc_docs] for the AlchemyLanguage.

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

Privacy Notice

Sample web applications that include this package may be configured to track deployments to IBM Bluemix and other Cloud Foundry platforms. The following information is sent to a Deployment Tracker service on each deployment:

• Node.js package version
• Node.js repository URL
• Application Name (application_name)
• Space ID (space_id)
• Application Version (application_version)
• Application URIs (application_uris)
• Labels of bound services
• Number of instances for each bound service and associated plan information

This data is collected from the package.json file in the sample application and the VCAP_APPLICATION and VCAP_SERVICES environment variables in IBM Bluemix and other Cloud Foundry platforms. This data is used by IBM to track metrics around deployments of sample applications to IBM Bluemix to measure the usefulness of our examples, so that we can continuously improve the content we offer to you. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked.