-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add folder structure for multiple apps in a repo (#11)
- Loading branch information
1 parent
f750315
commit c91bf21
Showing
9 changed files
with
81 additions
and
44 deletions.
There are no files selected for viewing
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,57 +1,37 @@ | ||
| > Edit Framework and/or Language into the title | ||
| # Deepgram **Language/Framework** Templates | ||
|
|
||
| # Framework/Language Demo Project | ||
| Please check out the demos contained in this repository, for examples of how to build Deepgram into your **Language/Framework** applications. | ||
|
|
||
| > Write an intro for this project | ||
| - [Web app](./Template-01/README.md) | ||
| - [Websockets](./Template-01/README.md) | ||
| - [Command-line script](./Template-01/README.md) | ||
|
|
||
| ## Sign-up to Deepgram | ||
| ## What is Deepgram? | ||
|
|
||
| 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). | ||
| Deepgram is an AI speech platform which specialises in (NLU) Natural Language Understanding features and Transcription. It can help get the following from your audio. | ||
|
|
||
| ## Quickstart | ||
| - [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/) | ||
|
|
||
| > Delete these sections as appropriate. Please include at least a manual one. | ||
| ## Create a Free Deepgram Account | ||
|
|
||
| ### Manual | ||
| Before you start, it's essential to generate a Deepgram API key to use in our demo applications. [Sign-up now for Deepgram](https://console.deepgram.com/signup). | ||
|
|
||
| > Edit as appropriate | ||
| ## Issue Reporting | ||
|
|
||
| 1. Manual steps | ||
| 2. To get this | ||
| 3. App working | ||
| 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](./.github/SECURITY.md) details the procedure for contacting Deepgram. | ||
|
|
||
| ### Deepgram CLI | ||
| ## Author | ||
|
|
||
| > Requires a deepgram.toml file correctly formatted to launch with the Deepgram CLI | ||
| [Deepgram](https://deepgram.com) | ||
|
|
||
| Having installed the [Deepgram CLI](https://github.com/deepgram-devs/deepgram-cli), run `deepgram generate blank-template-project` to clone and set up [deepgram-templates/blank-template-project](https://github.com/deepgram-templates/blank-template-project) on your machine. | ||
| ## License | ||
|
|
||
| ### Glitch Remix | ||
|
|
||
| > Requires .env file. Please describe steps here to edit the blank .env file after it has been remixed. **Do not prepopulate** the .env file that might be overwritten by any CLI setup scripts. Anything prepopulated should be placed in the sample .env file for the CLI, and the .env file for Glitch. | ||
| [](https://glitch.com/edit/#!/import/github/deepgram-templates/blank-template-project) | ||
|
|
||
| ### StackBlitz | ||
|
|
||
| > Please use a .stackblitzrc file to define a startCommand: https://developer.stackblitz.com/guides/integration/open-from-github#launching-a-script-on-project-load | ||
| [](https://stackblitz.com/fork/github/deepgram-templates/blank-template-project) | ||
|
|
||
| ### Heroku | ||
|
|
||
| > Please use an app.json file to define how Heroku should bootstrap your application: https://devcenter.heroku.com/articles/app-json-schema | ||
| [](https://heroku.com/deploy?template=https://github.com/deepgram-templates/blank-template-project) | ||
|
|
||
| ### Netlify | ||
|
|
||
| > Please use a netlify.toml file to define how Netlify should bootstrap your application: https://docs.netlify.com/site-deploys/create-deploys/#template-configuration | ||
| [](https://github.com/deepgram-templates/blank-template-project) | ||
|
|
||
| ## Related Content | ||
|
|
||
| - Any Deepgram content or docs | ||
| - related to this demo app | ||
| - In a nice long list | ||
| This project is licensed under the MIT license. See the [LICENSE](./LICENSE) file for more info. |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,57 @@ | ||
| > Edit Framework and/or Language into the title | ||
| # Framework/Language Demo Project | ||
|
|
||
| > Write an intro for this project | ||
| ## Sign-up to Deepgram | ||
|
|
||
| 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 | ||
|
|
||
| > Delete these sections as appropriate. Please include at least a manual one. | ||
| ### Manual | ||
|
|
||
| > Edit as appropriate | ||
| 1. Manual steps | ||
| 2. To get this | ||
| 3. App working | ||
|
|
||
| ### Deepgram CLI | ||
|
|
||
| > Requires a deepgram.toml file correctly formatted to launch with the Deepgram CLI | ||
| Having installed the [Deepgram CLI](https://github.com/deepgram-devs/deepgram-cli), run `deepgram generate blank-template-project` to clone and set up [deepgram-templates/blank-template-project](https://github.com/deepgram-templates/blank-template-project) on your machine. | ||
|
|
||
| ### Glitch Remix | ||
|
|
||
| > Requires .env file. Please describe steps here to edit the blank .env file after it has been remixed. **Do not prepopulate** the .env file that might be overwritten by any CLI setup scripts. Anything prepopulated should be placed in the sample .env file for the CLI, and the .env file for Glitch. | ||
| [](https://glitch.com/edit/#!/import/github/deepgram-templates/blank-template-project) | ||
|
|
||
| ### StackBlitz | ||
|
|
||
| > Please use a .stackblitzrc file to define a startCommand: https://developer.stackblitz.com/guides/integration/open-from-github#launching-a-script-on-project-load | ||
| [](https://stackblitz.com/fork/github/deepgram-templates/blank-template-project) | ||
|
|
||
| ### Heroku | ||
|
|
||
| > Please use an app.json file to define how Heroku should bootstrap your application: https://devcenter.heroku.com/articles/app-json-schema | ||
| [](https://heroku.com/deploy?template=https://github.com/deepgram-templates/blank-template-project) | ||
|
|
||
| ### Netlify | ||
|
|
||
| > Please use a netlify.toml file to define how Netlify should bootstrap your application: https://docs.netlify.com/site-deploys/create-deploys/#template-configuration | ||
| [](https://github.com/deepgram-templates/blank-template-project) | ||
|
|
||
| ## Related Content | ||
|
|
||
| - Any Deepgram content or docs | ||
| - related to this demo app | ||
| - In a nice long list |
File renamed without changes.
File renamed without changes.
File renamed without changes.