Copy the entire contents of https://github.com/deepgram-starters/deepgram-starters-ui to the ./static/ folder.

The name of the project and repo, is less important than the correct configuration of the deepgram.toml file, if you wish for it to be included in future onboarding workflows.

[Usecase] [Language] Starter

Write an intro for this project

Nifty little into, maybe a screenshot.

Sign-up to Deepgram

Please leave this section unchanged, unless providing a UTM on the URL.

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

Quickstart

Detail the manual steps to get started.

e.g.

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

Config file can be any appropriate file for the framework/language. For e.g. Node is using a config.json file, while Python is only use .env files

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 application

to support the UI, it must always run on port 8080

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

npm start

What is Deepgram?

Deepgram is an AI speech platform which specializes in (NLU) Natural Language Understanding features and Transcription. It can help get the following from your audio.

• Speaker diarization
• Language detection
• Summarization
• Topic detection
• Language translation
• Sentiment analysis
• Entity detection
• Transcription
• Redaction

Create a Free Deepgram Account

Before you start, it's essential to generate a Deepgram API key to use in our starter applications. Sign-up now for Deepgram.

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.

Author

Deepgram

License

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