Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/watson-developer-cloud/tone-analyzer-nodejs
Sample Node.js Application for the IBM Tone Analyzer Service
https://github.com/watson-developer-cloud/tone-analyzer-nodejs
Last synced: 3 months ago
JSON representation
Sample Node.js Application for the IBM Tone Analyzer Service
- Host: GitHub
- URL: https://github.com/watson-developer-cloud/tone-analyzer-nodejs
- Owner: watson-developer-cloud
- License: apache-2.0
- Archived: true
- Created: 2015-07-15T09:36:11.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2022-06-23T18:51:53.000Z (over 2 years ago)
- Last Synced: 2024-07-10T20:55:25.199Z (4 months ago)
- Language: CSS
- Homepage: https://tone-analyzer-demo.ng.bluemix.net/
- Size: 3.02 MB
- Stars: 452
- Watchers: 54
- Forks: 274
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ibmcloud - tone-analyzer-nodejs - Sample Node.js Application for the IBM Tone Analyzer Service. (Data & AI)
README
🚀 Tone Analyzer Sample Application
This Node.js app demonstrates some of the Tone Analyzer service features.
The IBM Watson [Tone Analyzer][docs] service is a cognitive linguistic analysis service that detects 7 tones which are most commonly used to detect the tone of written text. These are: anger, fear, joy, sadness, confident, analytical, and tentative.
[](https://greenkeeper.io/)
## Prerequisites
1. Sign up for an [IBM Cloud account](https://cloud.ibm.com/registration/).
1. Download the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli/index.html#overview).
1. Create an instance of the Tone Analyzer service and get your credentials:
- Go to the [Tone Analyzer](https://cloud.ibm.com/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, or copy the `username` and `password` values if your service instance doesn't provide an `apikey`.
- 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-wdc.watsonplatform.net/tone-analyzer/api
```
- If your service instance uses `username` and `password` credentials, add the `TONE_ANALYZER_USERNAME` and `TONE_ANALYZER_PASSWORD` variables to the *.env* file.
Example *.env* file that configures the `username`, `password`, and `url` for a Tone Analyzer service instance hosted in the Sydney region:
```
TONE_ANALYZER_USERNAME=522be-7b41-ab44-dec3-g1eab2ha73c6
TONE_ANALYZER_PASSWORD=A4Z5BdGENrwu8
TONE_ANALYZER_URL=https://gateway-syd.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://cloud.ibm.com/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
## Deploying to IBM Cloud as a Kubernetes Application
1. Login to IBM Cloud with the [IBM Cloud CLI](https://cloud.ibm.com/docs/cli/index.html#overview)
```
ibmcloud login
```
1. Install the Kubernetes CLI and configure it to run [`kubectl`](https://console.bluemix.net/docs/containers/cs_cli_install.html#cs_cli_configure) commands.
1. Edit the `kube-deploy.yaml` file and update the environment variables in the container with the service credentials
1. Deploy the application
```bash
kubectl apply -f kube-deploy.yaml
```
Expected output:
```none
service/tone-analyzer-nodejs created
deployment.apps/tone-analyzer-nodejs created
ingress.extensions/tone-analyzer-nodejs created
```
## License
This sample code is licensed under Apache 2.0.
Full license text is available in [LICENSE](LICENSE).
## Contributing
See [CONTRIBUTING](CONTRIBUTING.md).
## Open Source @ IBM
Find more open source projects on the
[IBM Github Page](http://ibm.github.io/).
[service_url]: https://www.ibm.com/watson/services/tone-analyzer/
[docs]: https://cloud.ibm.com/docs/services/tone-analyzer/index.html#about