Skip to content

Latest commit

 

History

History
executable file
·
126 lines (88 loc) · 4.66 KB

README.md

File metadata and controls

executable file
·
126 lines (88 loc) · 4.66 KB
Raw

AlchemyLanguage Demo

Build Status codecov.io

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.

Deploy to Bluemix

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

Getting Started

  1. Create a Bluemix Account

Sign up in Bluemix, or use an existing account.

  1. Download and install the Cloud-foundry CLI tool

  2. Edit the manifest.yml file and change the - name: alchemy-language-demo line to to something unique.

---
declared-services:
  alchemy-service:
    label: alchemy_api
    plan: standard
applications:
- name: <application-name>
  command: npm start
  memory: 512MB
  services:
  - alchemy-service
  env:
    NPM_CONFIG_PRODUCTION: false

The name you use will determinate your application url initially, e.g. <application-name>.mybluemix.net.

  1. Connect to Bluemix in the command line tool For US Region
$ cf api https://api.ng.bluemix.net
$ cf login -u <your user ID>
  1. Create the AlchemyLanguage Service in Bluemix
$ cf create-service alchemy_api standard alchemy-service

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 manifest.yml to point to it.

  1. Push it live!
$ cf push

See the full Getting Started documentation for more details, including code snippets and references.

Running locally

The application uses Node.js and npm.

  1. Copy the apikey from your alchemy-service service in Bluemix to a .env file in the root directory (ALCHEMY_LANGUAGE_API_KEY=<apikey>)
  2. Install Node.js
  3. Go to the project folder in a terminal and run: 
    npm install
  4. Start the application 
    npm start
  5. Go to http://localhost:3000

Troubleshooting

To troubleshoot your Bluemix application, use the logs. To see the logs, run:

$ cf logs <application-name> --recent

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

Privacy Notice

This node sample web application includes code to track deployments to Bluemix and other Cloud Foundry platforms. The following information is sent to a Deployment Tracker service on each deployment:

  • Application Name (application_name)
  • Space ID (space_id)
  • Application Version (application_version)
  • Application URIs (application_uris)

This data is collected from the VCAP_APPLICATION environment variable 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. Only deployments of sample applications that include code to ping the Deployment Tracker service will be tracked.

Disabling Deployment Tracking

Deployment tracking can be disabled by removing require('cf-deployment-tracker-client').track(); from the beginning of the server.js file at the root of this repo.