Skip to content

Commit

Permalink
Update README.md (watson-developer-cloud#33)
Browse files Browse the repository at this point in the history
* Update README.md

- Update REAME to match other sample apps

* Update README.md

- Updates

* Update README.md

- Updates
  • Loading branch information
Sud-Puth authored and dgterry committed Aug 2, 2016
1 parent 906c96a commit 9ae9fe6
Showing 1 changed file with 21 additions and 22 deletions.
43 changes: 21 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,17 @@ When setup is complete, you are informed that you need to add a WORKSPACE_ID.
- Ensure that you have [Websphere Liberty Profile Server](https://developer.ibm.com/wasdev/downloads/liberty-profile-using-non-eclipse-environments/).


## Setup Bluemix components

<a name="returnlocal">
1 In Bluemix, [create a Conversation Service](http://www.ibm.com/watson/developercloud/doc/conversation/convo_getstart.shtml).
- Create the [Service Credentials](#credentials).
- [Import a workspace](#workspace)
</a>

2 In Bluemix, [create a Retrieve and Rank Service](http://www.ibm.com/watson/developercloud/doc/retrieve-rank/get_start.shtml).
- Create the [Service Credentials](#credentials).

## Building locally

To build the application:
Expand All @@ -112,43 +123,31 @@ To build the application:

4 The built WAR file (conversation-enhanced-0.1-SNAPSHOT.war) is in the `conversation-enhanced/build/libs/` folder.

5 Copy the WAR file into the Liberty install directory's dropins folder. For example, `<liberty install directory>/usr/servers/<server profile>/dropins`.

## Setup Bluemix components

<a name="returnlocal">
1 In Bluemix, [create a Conversation Service](http://www.ibm.com/watson/developercloud/doc/conversation/convo_getstart.shtml).
- Create the [Service Credentials](#credentials).
- [Import a workspace](#workspace)
</a>

2 In Bluemix, [create a Retrieve and Rank Service](http://www.ibm.com/watson/developercloud/doc/retrieve-rank/get_start.shtml).
- Create the [Service Credentials](#credentials).

## Running locally

1 Copy the WAR file generated above into the Liberty install directory's dropins folder. For example, `<liberty install directory>/usr/servers/<server profile>/dropins`.

1 Navigate to the `conversation-enhanced/src/main/resources` folder. Copy the `server.env` file.
2 Navigate to the `conversation-enhanced/src/main/resources` folder. Copy the `server.env` file.

2 Navigate to the `<liberty install directory>/usr/servers/<server name>/` folder (where < server name > is the name of the Liberty server you wish to use). Paste the `server.env` here.
3 Navigate to the `<liberty install directory>/usr/servers/<server name>/` folder (where < server name > is the name of the Liberty server you wish to use). Paste the `server.env` here.

3 In the `server.env` file, search for **"retrieve_and_rank"**:
4 In the `server.env` file, search for **"retrieve_and_rank"**:
- Replace the "name" field with the name you gave your Retrieve and Rank Service.
- Replace the "password" field.
- Replace the "username" field.

4 In the `server.env`, search for **"conversation"**.
5 In the `server.env`, search for **"conversation"**.
- Replace the "name" field with the name you gave your Conversation Service.
- Replace the "password" field.
- Replace the "username" field.

5 Add the **WORKSPACE_ID** that you [copied earlier](#workspaceID).
6 Add the **WORKSPACE_ID** that you [copied earlier](#workspaceID).

6 Start the server using Eclipse or CLI with the command `server run <server name>` (use the name you gave your server).
7 Start the server using Eclipse or CLI with the command `server run <server name>` (use the name you gave your server).

7 Liberty notifies you when the server starts and includes the port information.
8 Liberty notifies you when the server starts and includes the port information.

8 Open your browser of choice and go to the URL displayed in Step 6. By default, this is `http://localhost:9080/`.
9 Open your browser of choice and go to the URL displayed in Step 6. By default, this is `http://localhost:9080/`.

<a name="credentials">
# Service Credentials
Expand Down Expand Up @@ -258,4 +257,4 @@ To see the logs, run the command
## Open Source @ IBM

Find more open source projects on the
[IBM Github Page](http://ibm.github.io/).
[IBM Github Page](http://ibm.github.io/).

0 comments on commit 9ae9fe6

Please sign in to comment.