feat: Initial commit

Author: lpatino10

.cfignore

@@ -0,0 +1,2 @@
+.git/
+node_modules/

.dockerignore

@@ -0,0 +1,2 @@
+.env
+node_modules/

.env.example

@@ -0,0 +1,2 @@
+SPEECH_TO_TEXT_APIKEY=<COPY-YOUR-API-KEY-HERE>
+SPEECH_TO_TEXT_URL=https://us-south.speech-to-text.watson.cloud.ibm.com

.eslintrc.json

@@ -0,0 +1,34 @@
+{
+  "env": {
+    "browser": true,
+    "commonjs": true,
+    "es6": true,
+    "node": true,
+    "jest": true
+  },
+  "extends": [
+    "eslint:recommended",
+    "plugin:jest/recommended",
+    "plugin:react/recommended"
+  ],
+  "globals": {
+    "Atomics": "readonly",
+    "SharedArrayBuffer": "readonly",
+    "page": true,
+    "browser": true,
+    "context": true,
+    "jestPuppeteer": true
+  },
+  "parserOptions": {
+    "ecmaFeatures": {
+      "jsx": true
+    },
+    "ecmaVersion": 2018,
+    "sourceType": "module"
+  },
+  "plugins": ["jest", "react", "react-hooks"],
+  "rules": {
+    "react-hooks/rules-of-hooks": "error",
+    "react-hooks/exhaustive-deps": "warn"
+  }
+}

.gitignore

@@ -0,0 +1,10 @@
+# Dependencies
+.npm
+node_modules
+
+# Config
+.next
+
+# Misc
+.DS_Store
+*.env

.travis.yml

@@ -0,0 +1,27 @@
+language: node_js
+sudo: required
+node_js: 12
+cache:
+  directories:
+    - node_modules
+env:
+  global:
+    - BX_APP=speech-to-text-code-pattern
+    - BX_API=https://api.ng.bluemix.net
+    - BX_ORGANIZATION=WatsonPlatformServices
+    - BX_SPACE=demos
+script:
+  - npm run build
+  - npm run test
+before_deploy:
+  - npm install -g bx-blue-green
+deploy:
+  - provider: script
+    skip_cleanup: true
+    script: bx-blue-green-travis
+    on:
+      branch: master
+      repo: watson-developer-cloud/speech-to-text-code-pattern
+  - provider: script
+    skip_cleanup: true
+    script: npx semantic-release

Dockerfile

@@ -0,0 +1,28 @@
+FROM node:12-alpine AS base
+WORKDIR /app
+
+FROM base as build
+COPY ./package*.js* /app/
+RUN npm set progress=false && \
+  npm config set depth 0 && \
+  npm install
+
+COPY ./config /app/config
+COPY ./public /app/public
+COPY ./src /app/src
+COPY ./test /app/test
+COPY ./*.js /app/
+
+RUN npm run build
+RUN npm run test:components
+
+FROM base as release
+
+COPY --from=build /app/build /app/build
+COPY --from=build /app/config /app/config
+COPY --from=build /app/*.js* /app/
+
+RUN npm install --only=prod
+
+EXPOSE 5000
+CMD ["npm", "start"]

Dockerfile-tools

@@ -0,0 +1,20 @@
+FROM ibmcom/ibmnode
+
+ADD . /app
+
+ENV NODE_ENV production
+ENV PORT 5000
+
+EXPOSE 5000
+
+WORKDIR /app
+
+RUN npm install
+CMD ["/bin/bash"]
+
+ARG bx_dev_user=root
+ARG bx_dev_userid=1000
+
+RUN BX_DEV_USER=$bx_dev_user
+RUN BX_DEV_USERID=$bx_dev_userid
+RUN if [ "$bx_dev_user" != root ]; then useradd -ms /bin/bash -u $bx_dev_userid $bx_dev_user; fi

README.md

@@ -0,0 +1,201 @@
+<h1 align="center" style="border-bottom: none;">Speech to Text Code Pattern 🗣</h1>
+<h3 align="center">Sample React app for playing around with the Watson Speech to Text service.</h3>
+<p align="center">
+  <a href="http://travis-ci.org/watson-developer-cloud/speech-to-text-code-pattern">
+    <img alt="Travis" src="https://travis-ci.org/watson-developer-cloud/speech-to-text-code-pattern.svg?branch=master">
+  </a>
+  <a href="#badge">
+    <img alt="semantic-release" src="https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg">
+  </a>
+</p>
+</p>
+
+✨ **Demo:** https://speech-to-text-code-pattern.mybluemix.net/ ✨
+
+## Flow
+
+<p align="center">
+  <img alt="architecture" width="600" src="./public/architecture.png">
+</p>
+
+1. User supplies an audio input to the application (running locally, in the IBM Cloud or in IBM Cloud Pak for Data).
+1. The application sends the audio data to the Watson Speech to Text service through a [WebSocket connection](https://cloud.ibm.com/docs/services/speech-to-text?topic=speech-to-text-websockets).
+1. As the data is processed, the Speech to Text service returns information about extracted text and other metadata to the application to display.
+
+## 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 Speech to Text service and get your credentials:
+   - Go to the [Speech to Text](https://console.bluemix.net/catalog/services/speech-to-text) 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.
+
+### Cloud Pak for Data
+
+To use this code pattern with a Speech to Text instance provisioned on Cloud Pak for Data, you can use your CPD `username` and `password` credentials or an `access_token` to authenticate your requests. You also need the service `url` as described [here](https://cloud.ibm.com/apidocs/speech-to-text/speech-to-text-data#authentication).
+
+Another important thing to note is that this code pattern assumes that you're using a **valid SSL certificate** for your CPD cluster. If not, you'll receive transcription errors. If you'd still like to use the app with an invalid certificate, you'll need to look up your browser-specific way to ignore these certificate errors. Do note that this is very insecure though!
+
+## Configuring the application
+
+Depending on where your service instance is you may have different ways to download the credentials file.
+
+> Need more information? See the [authentication wiki](https://github.com/IBM/node-sdk-core/blob/master/AUTHENTICATION.md).
+
+### Automatically
+
+Copy the credential file to the application folder.
+
+**Cloud Pak for Data**
+
+<p align="center">
+  <img alt="CPD"  width="600" src="https://watson-developer-cloud.github.io/images/credentials-cpd.png">
+</p>
+
+**Public Cloud**
+
+<p align="center">
+  <img alt="public"  width="600" src="https://watson-developer-cloud.github.io/images/credentials-public.png">
+</p>
+
+### Manually
+
+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 depending on your environment.
+
+   Example `.env` file that configures the `apikey` and `url` for a Speech to Text service instance hosted in the US South region:
+
+   ```
+   SPEECH_TO_TEXT_APIKEY=12345abcde
+   SPEECH_TO_TEXT_URL=https://stream.watsonplatform.net/speech-to-text/api
+   ```
+
+   - **CPD using username and password:** If your service instance is running in Cloud Pak for Data and you want to use `username` and `password` credentials, add the following variables to the `.env` file.
+
+     ```
+     SPEECH_TO_TEXT_USERNAME=admin
+     SPEECH_TO_TEXT_PASSWORD=password
+     SPEECH_TO_TEXT_URL=https://{cpd-url}:{cpd-port}/speech-to-text/api
+     ```
+
+   - **CPD using access token:** If your service instance is running in Cloud Pak for Data and you want to use the `access_token` from the service instance detail page, add the following:
+
+     ```
+     SPEECH_TO_TEXT_BEARER_TOKEN=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.ey...
+     SPEECH_TO_TEXT_URL=https://{cpd-url}:{cpd-port}/speech-to-text/api
+     ```
+
+## Running locally
+
+1. Install the dependencies
+
+   ```
+   npm install
+   ```
+
+1. Build the application
+
+   ```
+   npm run build
+   ```
+
+1. Run the application
+
+   ```
+   npm run dev
+   ```
+
+1. View the application in a browser at `localhost:3000`
+
+## Deploying to IBM Cloud as a Cloud Foundry Application
+
+Click on the button below to deploy this demo to the IBM Cloud.
+
+[![Deploy to IBM Cloud](https://cloud.ibm.com/devops/setup/deploy/button.png)](https://cloud.ibm.com/devops/setup/deploy?repository=https://github.com/watson-developer-cloud/speech-to-text-code-pattern)
+
+1. Build the application
+
+   ```
+   npm run build
+   ```
+
+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
+
+## Tests
+
+#### Unit tests
+
+Run unit tests with:
+
+```
+npm run test:components
+```
+
+See the output for more info.
+
+#### Integration tests
+
+First you have to make sure your code is built:
+
+```
+npm run build
+```
+
+Then run integration tests with:
+
+```
+npm run test:integration
+```
+
+## Directory structure
+
+```none
+.
+├── app.js                      // Express routes
+├── config                      // Express configuration
+│   ├── error-handler.js
+│   ├── express.js
+│   └── security.js
+├── package.json
+├── public                      // Static resources
+├── server.js                   // Entry point
+├── test                        // Tests
+└── src                         // React client
+    └── index.js                // App entry point
+```
+
+## License
+
+This sample code is licensed under the [MIT License](https://opensource.org/licenses/MIT).
+
+## Open Source @ IBM
+
+Find more open source projects on the [IBM Github Page](http://ibm.github.io/)