Skip to content

deepgram-starters/node-live-text-to-speech

Repository files navigation

Node Live Text-to-Speech Starter

Get started using Deepgram's Live Text-to-Speech with this Node demo app.

The flow of this sample is:

  1. A websocket is opened from the UI to the backend Javascript component
  2. Text is sent over a websocket to the backend component
  3. If a connection has not been established to Deepgram, create a websocket connection using the Javascript SDK and send the text to convert to audio
  4. An audio byte response with synthesized text-to-speech is returned and forward back through the WebSocket created by the UI
  5. Those audio bytes are then played by the media device contained within your browser

A preview of the app

What is Deepgram?

Deepgram is a voice AI company providing speech-to-text and language understanding capabilities to make data readable and actionable by human or machines.

Sign-up to Deepgram

Before you start, it's essential to generate a Deepgram API key to use in this project. Sign-up now for Deepgram and create an API key.

Quickstart

Manual

Follow these steps to get started with this starter application.

Clone the repository

Go to GitHub and clone the repository.

Install dependencies

Install the project dependencies.

npm install

Edit the config file

Copy the code from sample.env and create a new file called .env. Paste in the code and enter your API key you generated in the Deepgram console.

DEEPGRAM_API_KEY=%api_key%

Run the Node Application

The start script will run a web and API server concurrently. Once running, you can access the application in your browser.

npm run start

Issue Reporting

If you have found a bug or if you have a feature request, please report them at this repository issues section. Please do not report security vulnerabilities on the public GitHub issue tracker. The Security Policy details the procedure for contacting Deepgram.

Getting Help

We love to hear from you so if you have questions, comments or find a bug in the project, let us know! You can either:

Author

Deepgram

License

This project is licensed under the MIT license. See the LICENSE file for more info.