bclark2 / visual-recognition-nodejs

:camera: Sample Node.js Application for the IBM Watson Visual Recognition Service

Visual Recognition + AlchemyVision Demo

Visual Recognition partnered with Alchemy Vision, allows you to derive insights from an image based on its visual content. You can organize image libraries, understand an individual image, and create custom classifiers for specific results that are tailored to your needs.

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

Getting Started

1. Create a Bluemix Account

Sign up in Bluemix, or use an existing account. Watson Services in Beta are free to use.

2. Download and install the Cloud-foundry CLI tool

3. Edit the manifest.yml file and change the <application-name> to something unique.

applications:
- services:
- visual-recognition-service
name: <application-name>
command: node app.js
path: .
memory: 512M

The name you use will determine your initial application URL, e.g. <application-name>.mybluemix.net.

4. Connect to Bluemix in the command line tool

$ cf api https://api.ng.bluemix.net
$ cf login -u <your user ID>

5. Create the Visual Recognition service in Bluemix

$ cf create-service visual_recognition free visual-recognition-service

6. Create the Alchemy service in Bluemix or copy your existing key into ALCHEMY_KEY in app.js

$ cf create-service alchemy_api free alchemy-service

7. 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 so you will have to download and install them as part of the steps below.

1. Copy the credentials from your visual-recognition-service service in Bluemix to app.js, you can see the credentials using:

   $ cf env <application-name>

   Example output:

   System-Provided:
   {
   "VCAP_SERVICES": {
     "visual_recognition": [{
         "credentials": {
           "url": "<url>",
           "password": "<password>",
           "username": "<username>"
         },
       "label": "visual_recognition",
       "name": "visual-recognition-service",
       "plan": "free"
    }]
   }
   }

   You need to copy username, password and url.

2. Install Node.js

3. Go to the project folder in a terminal and run: npm install

4. Start the application

5. npm start

6. Go to http://localhost:3000

Troubleshooting

To troubleshoot your Bluemix app the main useful source of information are the logs, to see them, 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.