Skip to content
This repository has been archived by the owner on Feb 15, 2023. It is now read-only.

Latest commit

 

History

History
104 lines (76 loc) · 3.7 KB

local.md

File metadata and controls

104 lines (76 loc) · 3.7 KB
Raw

Run locally

This document shows how to run the speech-to-text-code-pattern application on your local machine.

Steps

  1. Clone the repo
  2. Configure credentials
  3. Start the server

Clone the repo

Clone speech-to-text-code-pattern repo locally. In a terminal, run:

git clone https://github.com/IBM/speech-to-text-code-pattern
cd speech-to-text-code-pattern

Configure credentials

Copy the .env.example file to .env.

cp .env.example .env

Edit the .env file to configure credentials before starting the Node.js server. The credentials to configure will depend on whether you are provisioning services using IBM Cloud Pak for Data or on IBM Cloud.

Click to expand one:

IBM Cloud Pak for Data

For the Speech to Text service, the following settings are needed:

  • Set SPEECH_TO_TEXT_AUTH_TYPE to cp4d
  • Provide the SPEECH_TO_TEXT_URL, SPEECH_TO_TEXT_USERNAME and SPEECH_TO_TEXT_PASSWORD collected in the previous step.
  • For the SPEECH_TO_TEXT_AUTH_URL use the base fragment of your URL including the host and port. I.e. https://{cpd_cluster_host}{:port}.
  • If your CPD installation is using a self-signed certificate, you need to disable SSL verification with SPEECH_TO_TEXT_AUTH_DISABLE_SSL set to true. You might also need to use browser-specific steps to ignore certificate errors (try browsing to the AUTH_URL). Disable SSL only if absolutely necessary, and take steps to enable SSL as soon as possible.
  • Make sure the examples for IBM Cloud and bearer token auth are commented out (or removed).
#----------------------------------------------------------
# IBM Cloud Pak for Data (username and password)
#
# If your services are running on IBM Cloud Pak for Data,
# uncomment and configure these.
# Remove or comment out the IBM Cloud section.
#----------------------------------------------------------

SPEECH_TO_TEXT_AUTH_TYPE=cp4d
SPEECH_TO_TEXT_URL=https://{cpd_cluster_host}{:port}/speech-to-text/{release}/instances/{instance_id}/api
SPEECH_TO_TEXT_AUTH_URL=https://{cpd_cluster_host}{:port}
SPEECH_TO_TEXT_USERNAME=<add_speech-to-text_username>
SPEECH_TO_TEXT_PASSWORD=<add_speech-to-text_password>
# If you use a self-signed certificate, you need to disable SSL verification.
# This is not secure and not recommended.
# SPEECH_TO_TEXT_AUTH_DISABLE_SSL=true

IBM Cloud

For the Speech to Text service, the following settings are needed:

  • Set SPEECH_TO_TEXT_AUTH_TYPE to iam
  • Provide the SPEECH_TO_TEXT_URL and SPEECH_TO_TEXT_APIKEY collected in the previous step.
  • Make sure the examples for IBM Cloud Pak for Data and bearer token auth are commented out (or removed).

#----------------------------------------------------------
# IBM Cloud
#
# If your services are running on IBM Cloud,
# uncomment and configure these.
# Remove or comment out the IBM Cloud Pak for Data sections.
#----------------------------------------------------------

SPEECH_TO_TEXT_AUTH_TYPE=iam
SPEECH_TO_TEXT_APIKEY=<add_speech-to-text_apikey>
SPEECH_TO_TEXT_URL=<add_speech-to-text_url>

Need more information? See the authentication wiki.

Start the server

npm install
npm start

The application will be available in your browser at http://localhost:5000. Return to the README.md for instructions on how to use the app.

return