Skip to content

Commit 2534145

Browse files
authored
chore: update deepgram.toml to V2 lifecycle format and rewrite README (#51)
Updated deepgram.toml from legacy build/config/post-build format to V2 lifecycle sections (check, install, start, update, clean, test). Added repository, sdk, and tags fields to meta. Rewrote README to concise community repo style.
1 parent 866ae5f commit 2534145

File tree

2 files changed

+41
-70
lines changed

2 files changed

+41
-70
lines changed

README.md

Lines changed: 12 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,77 +1,27 @@
1-
# Next.js Live Transcription Starter
1+
# Next.js Live Transcription
22

3-
[![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4)
3+
Get started using Deepgram's Live Transcription with this Next.js demo app.
44

5-
The purpose of this demo is to showcase how you can build a NextJS speech to text app using [Deepgram](https://deepgram.com/).
5+
<!-- [**Live Demo →**](https://nextjs-live-transcription.vercel.app/) -->
66

7-
## Live Demo
8-
You can see the demo in action on Vercel: https://nextjs-live-transcription.vercel.app/
7+
## Quick Start
98

10-
## Demo features
9+
Click the button below to fork the repo:
1110

12-
Capture streaming audio using [Deepgram Streaming Speech to Text](https://developers.deepgram.com/docs/getting-started-with-live-streaming-audio).
11+
[![Fork on GitHub](https://img.shields.io/badge/Fork_on_GitHub-blue?logo=github)](https://github.com/deepgram-devs/nextjs-live-transcription/fork)
1312

14-
## What is Deepgram?
15-
16-
[Deepgram’s](https://deepgram.com/) voice AI platform provides APIs for speech-to-text, text-to-speech, and full speech-to-speech voice agents. Over 200,000+ developers use Deepgram to build voice AI products and features.
17-
18-
## Sign-up to Deepgram
19-
20-
Want to start building using this project? [Sign-up now for Deepgram and create an API key](https://console.deepgram.com/signup?jump=keys).
21-
22-
## Quickstart
23-
24-
### Manual
25-
26-
Follow these steps to get started with this starter application.
27-
28-
#### Clone the repository
29-
30-
Go to GitHub and [clone the repository](https://github.com/deepgram-starters/nextjs-live-transcription).
31-
32-
#### Install dependencies
33-
34-
Install the project dependencies.
13+
## Local Development
3514

3615
```bash
16+
git clone https://github.com/deepgram-devs/nextjs-live-transcription.git
17+
cd nextjs-live-transcription
3718
npm install
38-
```
39-
40-
#### Edit the config file
41-
42-
Copy the code from `sample.env.local` and create a new file called `.env.local`.
43-
44-
```bash
45-
DEEPGRAM_API_KEY=YOUR-DG-API-KEY
46-
```
47-
48-
For `DEEPGRAM_API_KEY` paste in the key you generated in the [Deepgram console](https://console.deepgram.com/).
49-
50-
#### Run the application
51-
52-
Once running, you can [access the application in your browser](http://localhost:3000).
53-
54-
```bash
19+
cp sample.env.local .env.local # Add your DEEPGRAM_API_KEY
5520
npm run dev
5621
```
5722

58-
## Issue Reporting
59-
60-
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](./SECURITY.md) details the procedure for contacting Deepgram.
61-
62-
63-
## Getting Help
64-
65-
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:
66-
67-
- [Open an issue in this repository](https://github.com/deepgram-starters/nextjs-live-transcription/issues)
68-
- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)
69-
- [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)
70-
71-
## Author
72-
73-
[Deepgram](https://deepgram.com)
23+
Open [http://localhost:3000](http://localhost:3000) in your browser.
7424

7525
## License
7626

77-
This project is licensed under the MIT license. See the [LICENSE](./LICENSE) file for more info.
27+
MIT - See [LICENSE](./LICENSE)

deepgram.toml

Lines changed: 29 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,38 @@
11
[meta]
2-
title = "Next.js Live Transcription Starter"
2+
title = "Next.js Live Transcription"
33
description = "Get started using Deepgram's Live Transcription with this Next.js demo app"
44
author = "Deepgram DX Team <devrel@deepgram.com> (https://developers.deepgram.com)"
5-
useCase = "Live STT"
6-
language = "JavaScript"
7-
framework = "Next"
5+
repository = "https://github.com/deepgram-devs/nextjs-live-transcription"
6+
useCase = "live-transcription"
7+
language = "javascript"
8+
framework = "next"
9+
sdk = "4.5.1"
10+
tags = ["live-transcription", "live-stt", "real-time-transcription", "streaming-transcription", "live-speech-to-text", "javascript", "next", "nextjs", "react"]
811

9-
[build]
12+
[check]
13+
command = ["command -v git", "command -v node", "command -v npm"]
14+
message = "Prerequisites checked"
15+
16+
[install]
1017
command = "npm install"
18+
message = "Dependencies installed"
1119

12-
[config]
20+
[install.config]
1321
sample = "sample.env.local"
1422
output = ".env.local"
1523

16-
[post-build]
17-
message = "Run `npm run dev` to get up and running locally."
24+
[start]
25+
command = "npm run dev"
26+
message = "Application running on http://localhost:3000"
27+
28+
[update]
29+
command = "npm update"
30+
message = "Dependencies updated"
31+
32+
[clean]
33+
command = ["rm -rf node_modules", "rm -rf .next"]
34+
message = "Build artifacts cleaned"
35+
36+
[test]
37+
command = "npm run lint"
38+
message = "Linting complete"

0 commit comments

Comments
 (0)