INSTRUCTIONS

1. If your app requires an UI use https://github.com/deepgram/starter-uis

2. The configuration of the deepgram.toml file and is needed for our Starter Ecosystem.

3. Consistent naming of the project repo is important. Please don't deviate from our standards. Example repo name: [language] [use case]

4. Use the README template below, don't deviate from it.

5. Recommended: Use the cursor rules with Cursor to help build your starter more quickly!

---

[Project Name]

[One-line description with tech stack]

Prerequisites

• Deepgram API Key (sign up for free)
• Framwork and tooling needed

Note: This project uses strict supply chain security measures. npm and yarn will NOT work. See SECURITY.md for details.

Quickstart

1. Clone the repository

Go to GitHub and clone the repository.

2. Install dependencies

# Option 1: Use the helper script (recommended)
command here

# Option 2: Manual two-step install
commands here

Note: Due to security settings (ignore-scripts=true), frontend dependencies must be installed separately. The install:all script handles both steps. See SECURITY.md for details.

3. Set your API key

Create a .env file:

DEEPGRAM_API_KEY=your_api_key_here

4. Run the app

Development mode (with hot reload):

command here

Production mode (build and serve):

commands here

🌐 Open the App

http://localhost:3000

How It Works

This application:

1. [Step 1]
2. [Step 2]
3. [Step 3]
4. [Step 4]

Getting Help

• Open an issue in this repository
• Join the Deepgram Github Discussions Community
• Join the Deepgram Discord Community

Contributing

See our Contributing Guidelines to learn about contributing to this project.

Code of Conduct

This project follows the Deepgram Code of Conduct.

Security

For security policy and procedures, see our Security Policy.

License

MIT - See LICENSE