|
1 | | -# Next.js Live Transcription Starter |
| 1 | +# Next.js Live Transcription |
2 | 2 |
|
3 | | -[](https://discord.gg/xWRaCDBtW4) |
| 3 | +Get started using Deepgram's Live Transcription with this Next.js demo app. |
4 | 4 |
|
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/) --> |
6 | 6 |
|
7 | | -## Live Demo |
8 | | -You can see the demo in action on Vercel: https://nextjs-live-transcription.vercel.app/ |
| 7 | +## Quick Start |
9 | 8 |
|
10 | | -## Demo features |
| 9 | +Click the button below to fork the repo: |
11 | 10 |
|
12 | | -Capture streaming audio using [Deepgram Streaming Speech to Text](https://developers.deepgram.com/docs/getting-started-with-live-streaming-audio). |
| 11 | +[](https://github.com/deepgram-devs/nextjs-live-transcription/fork) |
13 | 12 |
|
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 |
35 | 14 |
|
36 | 15 | ```bash |
| 16 | +git clone https://github.com/deepgram-devs/nextjs-live-transcription.git |
| 17 | +cd nextjs-live-transcription |
37 | 18 | 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 |
55 | 20 | npm run dev |
56 | 21 | ``` |
57 | 22 |
|
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. |
74 | 24 |
|
75 | 25 | ## License |
76 | 26 |
|
77 | | -This project is licensed under the MIT license. See the [LICENSE](./LICENSE) file for more info. |
| 27 | +MIT - See [LICENSE](./LICENSE) |
0 commit comments