https://github.com/watson-developer-cloud/customer-engagement-nodejs
Customer Engagement
https://github.com/watson-developer-cloud/customer-engagement-nodejs
Last synced: 12 months ago
JSON representation
Customer Engagement
- Host: GitHub
- URL: https://github.com/watson-developer-cloud/customer-engagement-nodejs
- Owner: watson-developer-cloud
- License: apache-2.0
- Created: 2017-04-13T19:21:24.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2022-12-30T19:06:11.000Z (over 3 years ago)
- Last Synced: 2025-05-19T05:38:47.588Z (about 1 year ago)
- Language: JavaScript
- Homepage:
- Size: 1.4 MB
- Stars: 10
- Watchers: 7
- Forks: 23
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
🚀 Customer Engagement Demo
## Prerequisites
1. Sign up for an [IBM Cloud account](https://console.bluemix.net/registration/).
1. Download the [IBM Cloud CLI](https://console.bluemix.net/docs/cli/index.html#overview).
1. Create an instance of the Tone Analyzer service and get your credentials:
- Go to the [Tone Analyzer](https://console.bluemix.net/catalog/services/tone-analyzer) page in the IBM Cloud Catalog.
- Log in to your IBM Cloud account.
- Click **Create**.
- Click **Show** to view the service credentials.
- Copy the `apikey` value.
- Copy the `url` value.
## Configuring the application
1. In the application folder, copy the _.env.example_ file and create a file called _.env_
```
cp .env.example .env
```
2. Open the _.env_ file and add the service credentials that you obtained in the previous step.
Example _.env_ file that configures the `apikey` and `url` for a Tone Analyzer service instance hosted in the US East region:
```
TONE_ANALYZER_IAM_APIKEY=X4rbi8vwZmKpXfowaS3GAsA7vdy17Qh7km5D6EzKLHL2
TONE_ANALYZER_URL=https://gateway.watsonplatform.net/tone-analyzer/api
```
## Running locally
1. Install the dependencies
```
npm install
```
1. Run the application
```
npm start
```
1. View the application in a browser at `localhost:3000`
## Deploying to IBM Cloud as a Cloud Foundry Application
1. Login to IBM Cloud with the [IBM Cloud CLI](https://console.bluemix.net/docs/cli/index.html#overview)
```
ibmcloud login
```
1. Target a Cloud Foundry organization and space.
```
ibmcloud target --cf
```
1. Edit the _manifest.yml_ file. Change the **name** field to something unique.
For example, `- name: my-app-name`.
1. Deploy the application
```
ibmcloud app push
```
1. View the application online at the app URL.
For example: https://my-app-name.mybluemix.net
---
### Directory structure
```none
.
├── 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
└── views // react components
```
## License
This sample code is licensed under Apache 2.0.
## Contributing
See [CONTRIBUTING](.github/CONTRIBUTING.md).
## Open Source @ IBM
Find more open source projects on the [IBM Github Page](http://ibm.github.io/)