Initial commit

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+Deepgram Developer Relations <[email protected]>.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.

CONTRIBUTING.md

@@ -0,0 +1,105 @@
+
+# Contributing Guidelines
+
+:+1::tada: We :heart: contributions from everyone! :tada::+1:
+
+It is a good idea to reach out with an issue first if you plan to add any new functionality. Otherwise, bug reports, bug fixes and feedback is always appreciated. Check out the [Contributing Guidelines][contributing] for more information and please follow the [GitHub Flow][githubflow].
+
+![contributions welcome][contribadge]
+
+The following is a set of guidelines for contributing to this project, which are hosted on GitHub. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+Please take the time to review the [Code of Conduct][coc], which all contributors are subject to on this project.
+
+[I don't want to read this whole thing, I just have a question!!!](#i-dont-want-to-read-this-whole-thing-i-just-have-a-question)
+
+[TOC]
+
+## Reporting Bugs
+
+This section guides you through submitting a bug report. Following these guidelines helps maintainers and the community understand your report :pencil:, reproduce the behavior :computer: :computer:, and find related reports :mag_right:.
+
+Before creating bug reports [please check for other issues,](#before-submitting-a-bug-report) as you might find out that you don't need to create one. When you are creating a bug report, please [include as many details as possible](#how-do-i-submit-a-good-bug-report). Fill out the issue, and include any information it asks for to help us resolve issues faster.
+
+> **Note:** If you find a **Closed** issue that seems like it is the same thing that you're experiencing, open a new issue and include a link to the original issue in the body of your new one.
+
+### Before Submitting A Bug Report
+
+* **Perform a cursory search** to see if the problem has already been reported. If it has **and the issue is still open**, add a comment to the existing issue instead of opening a new one.
+
+### How Do I Submit A (Good) Bug Report?
+
+Bugs are tracked as GitHub issues. Create an issue and provide the following information as required or necessary.
+
+Explain the problem and include additional details to help maintainers reproduce the problem:
+
+* **Use a clear and descriptive title** for the issue to identify the problem.
+* **Describe the exact steps which reproduce the problem** in as many details as possible. For example, start by explaining how you started. When listing steps, **don't just say what you did, but explain how you did it**.
+* **Provide specific examples to demonstrate the steps**. Include links to files or copy/pasteable snippets, which you use in those examples. If you're providing snippets in the issue, use [Markdown code blocks][githubcodeblocks].
+* **Describe the behavior you observed after following the steps** and point out what exactly is the problem with that behavior.
+* **Explain which behavior you expected to see instead and why.**
+* **Include screenshots and animated GIFs** where possible. Show how you follow the described steps and clearly demonstrate the problem. You can use [this tool][licecap] to record GIFs on macOS and Windows, and [this tool][silentcast] on Linux.
+* **If the problem wasn't triggered by a specific action**, describe what you were doing before the problem happened and share more information using the guidelines below.
+* **Can you reliably reproduce the issue?** If not, provide details about how often the problem happens and under which conditions it normally happens.
+Include details about your configuration and environment:
+
+## Suggesting Enhancements
+
+This section guides you through submitting a suggestion, including completely new features and minor improvements to existing functionality. Following these guidelines helps maintainers and the community understand your suggestion :pencil: and find related suggestions :mag_right:.
+
+Before creating enhancement suggestions, please check [this list](#before-submitting-an-enhancement-suggestion) as you might find out that you don't need to create one. When you are creating an enhancement suggestion, please [include as many details as possible](#how-do-i-submit-a-good-enhancement-suggestion). Fill out [the required template][featurerequest], the information it asks for helps us resolve issues faster.
+
+### Before Submitting An Enhancement Suggestion
+
+* **Perform a cursory search** to see if the enhancement has already been suggested. If it has, add a comment to the existing issue instead of opening a new one.
+
+### How Do I Submit A (Good) Enhancement Suggestion?
+
+Enhancement suggestions are tracked as GitHub issues. Create an issue and provide the following information.
+
+* **Use a clear and descriptive title** for the issue to identify the suggestion.
+* **Provide a step-by-step description of the suggested enhancement** in as many details as possible.
+* **Provide specific examples to demonstrate the steps**. Include copy/pasteable snippets which you use in those examples, as [Markdown code blocks][githubcodeblocks].
+* **Describe the current behavior** and **explain which behavior you expected to see instead** and why.
+* **Explain why this enhancement would be useful** to most users.
+
+## Your First Code Contribution
+
+Unsure where to begin contributing? You can start by looking through these `beginner` and `help-wanted` issues on any of our projects. While not perfect, number of comments is a reasonable proxy for impact a given change will have.
+
+## Pull Requests
+
+Please follow these steps to have your contribution considered by the maintainers:
+
+1. Follow all instructions in [the template][pullrequest]
+2. Adhear the [Code of Conduct][coc]
+3. After you submit your pull request, verify that all [status checks][githubstatuschecks] are passing.
+
+While the prerequisites above must be satisfied prior to having your pull request reviewed, the reviewer(s) may ask you to complete additional design work, tests, or other changes before your pull request can be ultimately accepted.
+
+# I don't want to read this whole thing I just have a question!!!
+
+You can join our community for any questions you might have:
+
+* [Contact our Developer Relations Team][community]
+* [Reach out on Twitter][twitter]
+    * This Twitter is monitored by our Marketing and Developer Relations team, but not 24/7—please be patient!
+
+Alternatively, you can raise an issue on the project.
+
+[contribadge]: https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat "Contributions Welcome"
+
+[coc]: CODE_OF_CONDUCT.md "Code of Conduct"
+[contributing]: CONTRIBUTING.md "Contributing"
+[license]: LICENSE "MIT License"
+[pullrequest]: PULL_REQUEST_TEMPLATE/PULL_REQUEST_TEMPLATE.md "Pull Request template"
+
+[community]: https://github.com/orgs/deepgram/discussions "Deepgram Community"
+[signup]: https://console.deepgram.com/signup "Deepgram Console"
+[twitter]: https://twitter.com/DeepgramAI "Deepgram on Twitter"
+
+[githubcodeblocks]: https://help.github.com/articles/markdown-basics/#multiple-lines "GitHub Markdown Code Blocks"
+[githubflow]: https://guides.github.com/introduction/flow/index.html "GitHub Flow"
+[githubstatuschecks]: https://help.github.com/articles/about-status-checks/ "GitHub Status Checks"
+[licecap]: https://www.cockos.com/licecap/ "LICEcap: animated screen captures"
+[silentcast]: https://github.com/colinkeenan/silentcast "Silentcast: silent mkv screencasts and animated gifs"

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Deepgram Templates
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,88 @@
+> 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](https://console.deepgram.com/signup).
+
+## 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](https://github.com/deepgram-starters/prerecorded-node-starter).
+
+#### Install dependencies
+
+Install the project dependencies.
+
+```bash
+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](https://console.deepgram.com/).
+
+```json
+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](http://localhost:8080/).
+
+```bash
+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](https://deepgram.com/product/speech-understanding/)
+- [Language detection](https://deepgram.com/product/speech-understanding/)
+- [Summarization](https://deepgram.com/product/speech-understanding/)
+- [Topic detection](https://deepgram.com/product/speech-understanding/)
+- [Language translation](https://deepgram.com/product/speech-understanding/)
+- [Sentiment analysis](https://deepgram.com/product/speech-understanding/)
+- [Entity detection](https://deepgram.com/product/speech-understanding/)
+- [Transcription](https://deepgram.com/product/transcription/)
+- [Redaction](https://deepgram.com/product/transcription/)
+
+## 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](https://console.deepgram.com/signup).
+
+## 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](./SECURITY.md) details the procedure for contacting Deepgram.
+
+## Author
+
+[Deepgram](https://deepgram.com)
+
+## License
+
+This project is licensed under the MIT license. See the [LICENSE](./LICENSE) file for more info.

SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+Deepgram's security policy can be found on our main website.
+
+[Deepgram Security Policy](https://developers.deepgram.com/documentation/security/security-policy/)

deepgram.toml

@@ -0,0 +1,17 @@
+[meta]
+  title = "<usecase> <language/framework> Starter" # update with usecase and framework
+  description = "Basic demo for using Deepgram to <do a thing> in <language/framework>" # update with usecase and framework
+  author = "Deepgram DX Team <[email protected]> (https://developers.deepgram.com)" # update for author details
+  useCase = "Prerecorded" # usecase
+  language = "Python" # base language
+  framework = "Flask" # framework if not native
+
+[build] # delete if no build/install steps applicable 
+  command = "pip install -r requirements.txt" # automatically install dependencies, delete if not applicable
+
+[config]
+  sample = "sample.env" # the example config file
+  output = ".env" # the file that we will generate using their API
+
+[post-build]
+  message = "Run `flask run -p 8080` to get up and running." # message to give users once setup is complete

sample.env

@@ -0,0 +1 @@
+DEEPGRAM_API_KEY=%api_key%