Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Steve Green committed Feb 15, 2019
1 parent c0aee0e commit 96e33c4
Showing 1 changed file with 1 addition and 48 deletions.
49 changes: 1 addition & 48 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,48 +1 @@
# Watson Assistant Demo for IBM.com - Redesign

### Build Status

| Branch | Status | Coverage |Link |
| ------------- |:-------------:| -----:|-----:|
| Master | [![Build Status](https://travis.ibm.com/Watson/watson-conversation-demo-redesign.svg?token=iJCYw8QYkDn5J4kz9weU&branch=master)](https://travis.ibm.com/Watson/watson-conversation-demo-redesign) | | https://watson-conversation-duo-dev.ng.bluemix.net/|
| Dev | [![Build Status](https://travis.ibm.com/Watson/watson-conversation-demo-redesign.svg?token=iJCYw8QYkDn5J4kz9weU&branch=dev)](https://travis.ibm.com/Watson/watson-conversation-demo-redesign) ||

This is the repository for an updated Watson Assistant demo, which is intended to be embedded directly within IBM.com on the Assistant service page. It runs on `bluemix.net` and will be `<iframe>`'d into the service page.

### Codebase Structure

```s
Root
/src
index.js (React frontend index)
/components
/ExampleComponentDirectory
ExampleComponent.js
ExampleComponent.test.js
/public
index.html (served at the root route)
/styles
duo-grid.min.css (Duo grid styles)
/js
bundle.js (imports the root react component)
/config
Configuration files for Express backend
/test
Backend unit and integration tests
index.js (express backend)
server.js (main backend entry point)
.config files
package.json
```

### How to run application

To run the application, you need to:

- `git clone` the repo

- `npm i` to install the dependencies

- Create an `.env` file with valid Assistant credentialss

- `npm start` to launch the server at `localhost:3000`
<h1 align="center" style="border-bottom: none;">🚀 Watson Assistant Demo Sample Application</h1>

0 comments on commit 96e33c4

Please sign in to comment.