Browser Client Quick Start

The official Speechly client libraries for various platforms enable you to get up and running with Speechly quickly.

See it in action

You can see the Speechly Browser Client in action here.

Web Client Quick Start

Developing on Windows?

If you are developing on Windows, you can install Linux on a virtual machine by following these instructions.
  1. In order to install the Speechly Browser Client, you’ll first need to have some common developer tools installed. These include Yarn and NodeJS. You’ll also need a Speechly app ID, which you get by signing up to the Speechly Dashboard.

  2. Clone the browser-client-example Github repository to your home directory, and move on to the directory where the browser-client-example is cloned.

$ cd ~ && git clone https://github.com/speechly/browser-client-example/ && cd browser-client-example
  1. Install the dependencies required for the Speechly Browser Client Example by using Yarn.
$ yarn install
  1. You’ll find your application ID on the Speechly Dashboard. Make sure your application status is Deployed.
Speechly SLU Examples configuration view showing Speechly app id
The app ID is encircled in blue.
  1. Add your application ID and the model language to environmental variables. By default, your app language is en-US, but it can be configured in the Speechly Dashboard. You can see the app language next to your app ID.
$ export REACT_APP_APP_ID="your-app-id" 
$ export REACT_APP_LANGUAGE="your-app-language" 
  1. Start the web application.
$ yarn start
Speechly Web Client example app starting in terminal
You should see the Speechly web client starting on your local machine.
  1. If your browser doesn’t do it automatically, open your browser and navigate to the address visible in the terminal window. This address is likely to be http://localhost:3000 .

  2. Click Connect, and give permission to allow your browser to use the microphone. Then click and hold the Record button, and say utterances that your model understands. Once you start speaking, you should be able to see the tentative transcript, intents, and entities, until finalized as per Speechly SLU loop.


Profile image for karoliina-louhema

Last updated by karoliina-louhema on May 26, 2020 at 09:32 +0300

Found an error on our documentation? Please file an issue or make a pull request