Skip to content
This repository was archived by the owner on Dec 31, 2020. It is now read-only.

Commit f1a36eb

Browse files
author
JAMES ZHANG
committed
first commit
0 parents  commit f1a36eb

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

69 files changed

+2170
-0
lines changed

‎.cfignore

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
node_modules/
2+
.idea/
3+
coverage
4+
.env
5+
npm-debug.log

‎.env.example

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Environment variables
2+
WORKSPACE_ID=
3+
CONVERSATION_USERNAME=
4+
CONVERSATION_PASSWORD=

‎.eslintignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
coverage

‎.eslintrc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
{
2+
"rules": {
3+
"no-console": 0,
4+
"func-names": 0,
5+
"vars-on-top": 0,
6+
"consistent-return": 0
7+
},
8+
"globals": {
9+
describe: true,
10+
it: true
11+
},
12+
"env": {
13+
"node": true
14+
},
15+
"extends": "eslint-config-airbnb-es5",
16+
}

‎.gitignore

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
node_modules/
2+
dist/
3+
temp/
4+
.idea/
5+
coverage
6+
.env
7+
npm-debug.log

‎.travis.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
language: node_js
2+
sudo: true
3+
cache:
4+
directories:
5+
- node_modules
6+
node_js: stable
7+
script:
8+
- npm run lint
9+
- npm test
10+
deploy:
11+
provider: cloudfoundry
12+
api: https://api.ng.bluemix.net
13+
username: $CF_USERNAME
14+
password: $CF_PASSWORD
15+
name: conversation-car-simple
16+
organization: WatsonPlatformServices
17+
space: demos
18+
on:
19+
repo: watson-developer-cloud/conversation-car-simple
20+
branch: master

‎LICENSE

Lines changed: 177 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,177 @@
1+
2+
Apache License
3+
Version 2.0, January 2004
4+
http://www.apache.org/licenses/
5+
6+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7+
8+
1. Definitions.
9+
10+
"License" shall mean the terms and conditions for use, reproduction,
11+
and distribution as defined by Sections 1 through 9 of this document.
12+
13+
"Licensor" shall mean the copyright owner or entity authorized by
14+
the copyright owner that is granting the License.
15+
16+
"Legal Entity" shall mean the union of the acting entity and all
17+
other entities that control, are controlled by, or are under common
18+
control with that entity. For the purposes of this definition,
19+
"control" means (i) the power, direct or indirect, to cause the
20+
direction or management of such entity, whether by contract or
21+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
22+
outstanding shares, or (iii) beneficial ownership of such entity.
23+
24+
"You" (or "Your") shall mean an individual or Legal Entity
25+
exercising permissions granted by this License.
26+
27+
"Source" form shall mean the preferred form for making modifications,
28+
including but not limited to software source code, documentation
29+
source, and configuration files.
30+
31+
"Object" form shall mean any form resulting from mechanical
32+
transformation or translation of a Source form, including but
33+
not limited to compiled object code, generated documentation,
34+
and conversions to other media types.
35+
36+
"Work" shall mean the work of authorship, whether in Source or
37+
Object form, made available under the License, as indicated by a
38+
copyright notice that is included in or attached to the work
39+
(an example is provided in the Appendix below).
40+
41+
"Derivative Works" shall mean any work, whether in Source or Object
42+
form, that is based on (or derived from) the Work and for which the
43+
editorial revisions, annotations, elaborations, or other modifications
44+
represent, as a whole, an original work of authorship. For the purposes
45+
of this License, Derivative Works shall not include works that remain
46+
separable from, or merely link (or bind by name) to the interfaces of,
47+
the Work and Derivative Works thereof.
48+
49+
"Contribution" shall mean any work of authorship, including
50+
the original version of the Work and any modifications or additions
51+
to that Work or Derivative Works thereof, that is intentionally
52+
submitted to Licensor for inclusion in the Work by the copyright owner
53+
or by an individual or Legal Entity authorized to submit on behalf of
54+
the copyright owner. For the purposes of this definition, "submitted"
55+
means any form of electronic, verbal, or written communication sent
56+
to the Licensor or its representatives, including but not limited to
57+
communication on electronic mailing lists, source code control systems,
58+
and issue tracking systems that are managed by, or on behalf of, the
59+
Licensor for the purpose of discussing and improving the Work, but
60+
excluding communication that is conspicuously marked or otherwise
61+
designated in writing by the copyright owner as "Not a Contribution."
62+
63+
"Contributor" shall mean Licensor and any individual or Legal Entity
64+
on behalf of whom a Contribution has been received by Licensor and
65+
subsequently incorporated within the Work.
66+
67+
2. Grant of Copyright License. Subject to the terms and conditions of
68+
this License, each Contributor hereby grants to You a perpetual,
69+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70+
copyright license to reproduce, prepare Derivative Works of,
71+
publicly display, publicly perform, sublicense, and distribute the
72+
Work and such Derivative Works in Source or Object form.
73+
74+
3. Grant of Patent License. Subject to the terms and conditions of
75+
this License, each Contributor hereby grants to You a perpetual,
76+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77+
(except as stated in this section) patent license to make, have made,
78+
use, offer to sell, sell, import, and otherwise transfer the Work,
79+
where such license applies only to those patent claims licensable
80+
by such Contributor that are necessarily infringed by their
81+
Contribution(s) alone or by combination of their Contribution(s)
82+
with the Work to which such Contribution(s) was submitted. If You
83+
institute patent litigation against any entity (including a
84+
cross-claim or counterclaim in a lawsuit) alleging that the Work
85+
or a Contribution incorporated within the Work constitutes direct
86+
or contributory patent infringement, then any patent licenses
87+
granted to You under this License for that Work shall terminate
88+
as of the date such litigation is filed.
89+
90+
4. Redistribution. You may reproduce and distribute copies of the
91+
Work or Derivative Works thereof in any medium, with or without
92+
modifications, and in Source or Object form, provided that You
93+
meet the following conditions:
94+
95+
(a) You must give any other recipients of the Work or
96+
Derivative Works a copy of this License; and
97+
98+
(b) You must cause any modified files to carry prominent notices
99+
stating that You changed the files; and
100+
101+
(c) You must retain, in the Source form of any Derivative Works
102+
that You distribute, all copyright, patent, trademark, and
103+
attribution notices from the Source form of the Work,
104+
excluding those notices that do not pertain to any part of
105+
the Derivative Works; and
106+
107+
(d) If the Work includes a "NOTICE" text file as part of its
108+
distribution, then any Derivative Works that You distribute must
109+
include a readable copy of the attribution notices contained
110+
within such NOTICE file, excluding those notices that do not
111+
pertain to any part of the Derivative Works, in at least one
112+
of the following places: within a NOTICE text file distributed
113+
as part of the Derivative Works; within the Source form or
114+
documentation, if provided along with the Derivative Works; or,
115+
within a display generated by the Derivative Works, if and
116+
wherever such third-party notices normally appear. The contents
117+
of the NOTICE file are for informational purposes only and
118+
do not modify the License. You may add Your own attribution
119+
notices within Derivative Works that You distribute, alongside
120+
or as an addendum to the NOTICE text from the Work, provided
121+
that such additional attribution notices cannot be construed
122+
as modifying the License.
123+
124+
You may add Your own copyright statement to Your modifications and
125+
may provide additional or different license terms and conditions
126+
for use, reproduction, or distribution of Your modifications, or
127+
for any such Derivative Works as a whole, provided Your use,
128+
reproduction, and distribution of the Work otherwise complies with
129+
the conditions stated in this License.
130+
131+
5. Submission of Contributions. Unless You explicitly state otherwise,
132+
any Contribution intentionally submitted for inclusion in the Work
133+
by You to the Licensor shall be under the terms and conditions of
134+
this License, without any additional terms or conditions.
135+
Notwithstanding the above, nothing herein shall supersede or modify
136+
the terms of any separate license agreement you may have executed
137+
with Licensor regarding such Contributions.
138+
139+
6. Trademarks. This License does not grant permission to use the trade
140+
names, trademarks, service marks, or product names of the Licensor,
141+
except as required for reasonable and customary use in describing the
142+
origin of the Work and reproducing the content of the NOTICE file.
143+
144+
7. Disclaimer of Warranty. Unless required by applicable law or
145+
agreed to in writing, Licensor provides the Work (and each
146+
Contributor provides its Contributions) on an "AS IS" BASIS,
147+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148+
implied, including, without limitation, any warranties or conditions
149+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150+
PARTICULAR PURPOSE. You are solely responsible for determining the
151+
appropriateness of using or redistributing the Work and assume any
152+
risks associated with Your exercise of permissions under this License.
153+
154+
8. Limitation of Liability. In no event and under no legal theory,
155+
whether in tort (including negligence), contract, or otherwise,
156+
unless required by applicable law (such as deliberate and grossly
157+
negligent acts) or agreed to in writing, shall any Contributor be
158+
liable to You for damages, including any direct, indirect, special,
159+
incidental, or consequential damages of any character arising as a
160+
result of this License or out of the use or inability to use the
161+
Work (including but not limited to damages for loss of goodwill,
162+
work stoppage, computer failure or malfunction, or any and all
163+
other commercial damages or losses), even if such Contributor
164+
has been advised of the possibility of such damages.
165+
166+
9. Accepting Warranty or Additional Liability. While redistributing
167+
the Work or Derivative Works thereof, You may choose to offer,
168+
and charge a fee for, acceptance of support, warranty, indemnity,
169+
or other liability obligations and/or rights consistent with this
170+
License. However, in accepting such obligations, You may act only
171+
on Your own behalf and on Your sole responsibility, not on behalf
172+
of any other Contributor, and only if You agree to indemnify,
173+
defend, and hold each Contributor harmless for any liability
174+
incurred by, or claims asserted against, such Contributor by reason
175+
of your accepting any such warranty or additional liability.
176+
177+
END OF TERMS AND CONDITIONS

‎README.md

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
# Conversation Car Simple
2+
[![Build Status](https://travis-ci.org/watson-developer-cloud/conversation-car-simple.svg?branch=master)](http://travis-ci.org/watson-developer-cloud/conversation-car-simple)
3+
[![codecov.io](https://codecov.io/github/watson-developer-cloud/conversation-car-simple/coverage.svg?branch=master)](https://codecov.io/github/watson-developer-cloud/conversation-car-simple?branch=master)
4+
5+
6+
This application demonstrates how the Conversation service uses intent capabilities in a simple chat interface.
7+
8+
[See the demo](http://deb-simple.stage1.mybluemix.net/).
9+
10+
Give it a try! Click the button below to fork into IBM DevOps Services and deploy your own copy of this application on Bluemix.
11+
12+
[![Deploy to Bluemix](https://bluemix.net/deploy/button.png)](https://bluemix.net/deploy?repository=https://github.com/watson-developer-cloud/conversation-car-simple)
13+
14+
## How the app works
15+
The app interface is designed and trained for chatting with a cognitive car. The chat interface is on the left, and the
16+
JSON that the JavaScript code receives from the server is on the right. Your questions and commands are run against a
17+
small set of sample data trained with intents like these:
18+
19+
* `lights`
20+
* `wipers`
21+
* `ac`
22+
23+
To see all the intents, open `/training/car_intents.csv`.
24+
25+
These intents help the system to understand variations of questions and commands that you might submit.
26+
For example, if you say "Wipers on" or "I want to turn on the windshield wipers," the system
27+
understands that in both cases your intent is the same and responds accordingly.
28+
29+
## Getting Started
30+
31+
1. Create a Bluemix Account
32+
33+
[Sign up][sign_up] in Bluemix, or use an existing account. Watson Beta or Experimental Services are free to use.
34+
35+
2. Download and install the [Cloud-foundry CLI][cloud_foundry] tool
36+
37+
3. Edit the `manifest.yml` file and change the `<application-name>` to something unique.
38+
```none
39+
applications:
40+
- services:
41+
- conversation-service
42+
name: <application-name>
43+
command: npm start
44+
path: .
45+
memory: 256M
46+
```
47+
48+
The name you use will determinate your application url initially, e.g. `<application-name>.mybluemix.net`.
49+
50+
4. Connect to Bluemix in the command line tool
51+
For US Region
52+
```sh
53+
$ cf api https://api.ng.bluemix.net
54+
```
55+
56+
```sh
57+
$ cf login -u <your user ID>
58+
```
59+
60+
5. Create the [Conversation][service_url] Service in Bluemix
61+
62+
```sh
63+
$ cf create-service conversation experimental conversation-service
64+
```
65+
66+
6. Push it live!
67+
68+
```sh
69+
$ cf push
70+
```
71+
72+
See the full [Getting Started][getting_started] documentation for more details, including code snippets and references.
73+
74+
## Running locally
75+
76+
The application uses [Node.js](http://nodejs.org/) and [npm](https://www.npmjs.com/).
77+
78+
1. Copy the credentials from your `conversation-service` service in Bluemix to a `.env` file in the root.
79+
1. Use the Conversation tooling app to create a workspace and add the id to the `.env` file.
80+
1. Install [Node.js](http://nodejs.org/)
81+
1. Go to the project folder in a terminal and run:
82+
```
83+
npm install
84+
```
85+
1. Start the application
86+
```
87+
npm start
88+
```
89+
6. Go to http://localhost:3000
90+
91+
## Troubleshooting
92+
93+
To troubleshoot your Bluemix application, use the logs. To see the logs, run:
94+
95+
```sh
96+
$ cf logs <application-name> --recent
97+
```
98+
99+
## License
100+
101+
This sample code is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
102+
103+
[service_url]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/conversation.html
104+
[cloud_foundry]: https://github.com/cloudfoundry/cli
105+
[getting_started]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/getting_started/
106+
[sign_up]: https://console.ng.bluemix.net/registration/

0 commit comments

Comments
 (0)