Skip to content
This repository was archived by the owner on Feb 13, 2018. It is now read-only.

watson-developer-cloud/document-conversion-nodejs

Β 
Β 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

78 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

Document Conversion Demo Build Status

The Document Conversion service transforms HTML, PDF, and Microsoftβ„’ Word documents into normalized HTML, plain text, or sets of Answer units. The Answer units can be run through a utility to convert it to the Solr JSON file type needed to train the Retrieve and Rank service.

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

Getting Started

  1. Create a Bluemix Account

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

  1. Download and install the Cloud-foundry CLI tool

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

applications:
- services:
  - document-conversion-service
  name: <application-name>
  path: .
  memory: 256M

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
$ cf api https://api.ng.bluemix.net
$ cf login -u <your user ID>
  1. Create the Document Conversion service in Bluemix
$ cf create-service document_conversion standard document-conversion-service
  1. Push it live!
$ cf push

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 document-conversion-service service in Bluemix to app.js, you can see the credentials using:

    $ cf env <application-name>

    Example output:

    System-Provided:
    {
    "VCAP_SERVICES": {
      "document_conversion": [{
          "credentials": {
            "url": "<url>",
            "password": "<password>",
            "username": "<username>"
          },
        "label": "document_conversion",
        "name": "document-conversion-service",
        "plan": "standard"
     }]
    }
    }

    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

Directory structure

.
β”œβ”€β”€ app.js                      // express routes
β”œβ”€β”€ config                      // express configuration
β”‚Β Β  β”œβ”€β”€ error-handler.js
β”‚Β Β  β”œβ”€β”€ express.js
β”‚Β Β  └── security.js
β”œβ”€β”€ manifest.yml
β”œβ”€β”€ package.json
β”œβ”€β”€ public                      // static resources
β”œβ”€β”€ server.js                   // entry point
β”œβ”€β”€ test                        // unit tests
β”œβ”€β”€ training
β”‚Β Β  └── weather_data_train.csv  // training file
└── views                       // react components

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 COPYING.

Contributing

See CONTRIBUTING.

Open Source @ IBM

Find more open source projects on the IBM Github Page