Skip to content

Commit 59b2f8f

Browse files
lukeocodeslukeocodes
committed
chore: create readme and community files
1 parent 398cb21 commit 59b2f8f

File tree

8 files changed

+355
-4
lines changed

8 files changed

+355
-4
lines changed

‎.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
name: Bug report
3+
about: Something is occurring that I think is wrong
4+
title: ''
5+
labels: "\U0001F41B bug"
6+
assignees: ''
7+
8+
---
9+
10+
## What is the current behavior?
11+
12+
> What's happening that seems wrong?
13+
14+
## Steps to reproduce
15+
16+
> To make it faster to diagnose the root problem. Tell us how can we reproduce the bug.
17+
18+
## Expected behavior
19+
20+
> What would you expect to happen when following the steps above?
21+
22+
## Please tell us about your environment
23+
24+
> We want to make sure the problem isn't specific to your operating system or programming language.
25+
26+
- **Operating System/Version:** Windows 10
27+
- **Language:** [all | TypeScript | Python | PHP | etc]
28+
- **Browser:** Chrome
29+
30+
## Other information
31+
32+
> Anything else we should know? (e.g. detailed explanation, stack-traces, related issues, suggestions how to fix, links for us to have context, eg. stack overflow, codepen, etc)

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Deepgram Developer Community
4+
url: https://github.com/orgs/deepgram/discussions
5+
- name: Deepgram on Twitter
6+
url: https://twitter.com/DeepgramAI

‎.github/ISSUE_TEMPLATE/feature-request.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
name: Feature Request
3+
about: I think X would be a cool addition or change.
4+
title: ''
5+
labels: "✨ enhancement"
6+
assignees: ''
7+
8+
---
9+
10+
## Proposed changes
11+
12+
> Provide a detailed description of the change or addition you are proposing
13+
14+
## Context
15+
16+
> Why is this change important to you? How would you use it? How can it benefit other users?
17+
18+
## Possible Implementation
19+
20+
> Not obligatory, but suggest an idea for implementing addition or change
21+
22+
## Other information
23+
24+
> Anything else we should know? (e.g. detailed explanation, related issues, links for us to have context, eg. stack overflow, codepen, etc)

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
## Proposed changes
2+
3+
Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request. If it fixes a bug or resolves a feature request, be sure to link to that issue.
4+
5+
## Types of changes
6+
7+
What types of changes does your code introduce to the Vonage for Visual Studio Code extension?
8+
_Put an `x` in the boxes that apply_
9+
10+
- [ ] Bugfix (non-breaking change which fixes an issue)
11+
- [ ] New feature (non-breaking change which adds functionality)
12+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
13+
- [ ] Documentation update or tests (if none of the other choices apply)
14+
15+
## Checklist
16+
17+
_Put an `x` in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code._
18+
19+
- [ ] I have read the [CONTRIBUTING](../../CONTRIBUTING.md) doc
20+
- [ ] Lint and unit tests pass locally with my changes
21+
- [ ] I have added tests that prove my fix is effective or that my feature works
22+
- [ ] I have added necessary documentation (if appropriate)
23+
- [ ] Any dependent changes have been merged and published in downstream modules
24+
25+
## Further comments
26+
27+
If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc...

‎CODE_OF_CONDUCT.md

Lines changed: 132 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
2+
# Code of Conduct
3+
4+
The Deepgram developer community is filled with amazing, clever and creative people, and we're excited for you to join us. Our goal is to create safe and inclusive spaces, have meaningful conversations, and explore ways to make sure that every voice is heard and understood.
5+
6+
#### Being a Good Community Member
7+
8+
Because we prioritize creating a safe space for our members, we believe in actively working on how we, as individuals, can ensure a positive community environment through our own actions and mindsets.
9+
10+
Every supportive community starts with each member. We feel it’s important to be open to others, respectful, and supportive. As part of the Deepgram community, please begin by thinking carefully about and agreeing with the following statements:
11+
12+
- I will be welcoming to everyone at the table;
13+
- I will be patient and open to learning from everyone around me;
14+
- I will treat everyone with respect, because they deserve it;
15+
- I will be mindful of the needs and boundaries of others;
16+
17+
We strive to create a space where we learn and grow together. Here are some other key things you can do to make the community great:
18+
19+
### BE HUMBLE
20+
21+
People come from all different places, and it’s best not to make assumptions about what they think or feel. Approach others with curiosity and openness. We **all** have a lot to learn from each other.
22+
23+
### BE HELPFUL
24+
25+
If someone asks for help, consider jumping in. You don’t have to be an expert to talk through a problem, suggest a resource, or help find a solution. We all have something to contribute.
26+
27+
### ENCOURAGE OTHERS
28+
29+
There’s no one path to have a career in technology or to this community. Let’s engage others in ways that create opportunities for learning and fun for all of us.
30+
31+
## Our Pledge
32+
33+
Everyone who participates in our community must agree to abide by our Code of Conduct. By agreeing, you help create a welcoming, respectful, and friendly community based on respect and trust. We are committed to creating a harassment-free community.
34+
35+
These rules will be strictly enforced in any and all of our official spaces, including direct messages, social media, and physical and virtual events. Everyone who participates in these spaces is required to agree to this community code. We also ask and expect community members to observe these rules anywhere the community is meeting (for example, online chats on unofficial platforms or event after-parties).
36+
37+
## Our Standards
38+
39+
### BE RESPECTFUL
40+
41+
Exercise consideration and respect in your speech and actions. Be willing to accept and give feedback gracefully.
42+
43+
Don’t make offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, neuro(a)typicality, physical appearance, body size, race, ethnicity, immigration status, religion, experience level, socioeconomic status, nationality, or other identity markers.
44+
45+
Additionally, don’t insult or demean others. This includes making unwelcome comments about a person’s lifestyle choices and practices, including things related to diet, health, parenting, drugs, or employment. It’s not okay to insult or demean others if it’s "just a joke."
46+
47+
### BE WELCOMING AND OPEN
48+
49+
Encourage others, be supportive and willing to listen, and be willing to learn from others’ perspectives and experiences. Lead with empathy and kindness.
50+
51+
Don’t engage in gatekeeping behaviors, like questioning the intelligence or knowledge of others as a way to prove their credentials. And don’t exclude people for prejudicial reasons.
52+
53+
### RESPECT PRIVACY
54+
55+
Do not publish private communications without consent. Additionally, never disclose private aspects of a person’s personal identity without consent, except as necessary to protect them from intentional abuse.
56+
57+
### RESPECT PERSONAL BOUNDARIES
58+
59+
Do not introduce gratuitous or off-topic sexual images, languages, or behavior in spaces where they are not appropriate. Never make physical contact or simulated physical contact without consent or after a request to stop. Additionally, do not continue to message others about anything if they ask you to stop or leave them alone.
60+
61+
#### BE A GOOD NEIGHBOR
62+
63+
Contribute to the community in a positive and thoughtful way. Consider what’s best for the overall community. Do not make threats of violence, intimidate others, incite violence or intimidation against others, incite self-harm, stalk, follow, or otherwise harass others. Be mindful of your surroundings and of your fellow participants.
64+
65+
Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
66+
67+
# Additional rules for online spaces
68+
69+
For Deepgram’s official online spaces, like our YouTube & Twitch chats, we have some additional rules. Any of the following behaviors can result in a ban without warning.
70+
71+
### DON'T SPAM
72+
73+
Don't spam. We'll ban you.
74+
75+
### KEEP IT LEGAL
76+
77+
If it’s illegal, it’s not allowed on our websites or in our online spaces. Please don’t share links to pirated material or other nefarious things.
78+
79+
### NO TROLLING
80+
81+
Please be earnest. Don’t use excessive sarcasm to annoy or undermine other people. And don’t bait them with bad faith comments or abuse.
82+
83+
### PORNOGRAPHY AND OTHER NSFW STUFF
84+
85+
Please don’t post it or link to it. It doesn’t belong in our online spaces.
86+
87+
### FOUL AND GRAPHIC LANGUAGE
88+
89+
Please do not use excessive curse words. Additionally, do not use graphic sexual or violent language — again, think of our spaces as places for people of all ages.
90+
91+
# Enforcement & Reporting
92+
93+
If you are being harassed by a member of the Deepgram developer community, if you observe someone else being harassed, or you experience actions or behaviors that are contrary to our Code of Conduct, please report the behavior using our [Code of Conduct Report Form](https://developers.deepgram.com/code-of-conduct/report-form/).
94+
95+
## Enforcement Guidelines
96+
97+
Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
98+
99+
### 1. Correction
100+
101+
**_Community Impact:_** Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
102+
103+
**_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.
104+
105+
### 2. Warning
106+
107+
**_Community Impact:_** A violation through a single incident or series of actions.
108+
109+
**_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.
110+
111+
### 3. Temporary Ban
112+
113+
**_Community Impact:_** A serious violation of community standards, including sustained inappropriate behavior.
114+
115+
**_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.
116+
117+
### 4. Permanent Ban
118+
119+
**_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.
120+
121+
**_Consequence:_** A permanent ban from any sort of public interaction within the community.
122+
123+
# Attribution
124+
125+
This Code of Conduct is adapted from:
126+
127+
- Contributor Covenant, version 2.0, available at https://www.contributor-covenant.org/version/2/0/code_of_conduct
128+
- https://eventhandler.community/conduct/, which itself is inspired by Quest, who in turn provides credit to Scripto, the #botALLY Code of Conduct, the LGBTQ in Tech code of Conduct, and the XOXO Code of Conduct.
129+
130+
Community Impact Guidelines, which were copied from InnerSource Commons, were inspired by Mozilla’s code of conduct enforcement ladder.
131+
132+
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

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Contributing Guidelines
2+
3+
Want to contribute to this project? We ❤️ it!
4+
5+
Here are a few types of contributions that we would be interested in hearing about.
6+
7+
- Bug fixes
8+
- If you find a bug, please first report it using Github Issues.
9+
- Issues that have already been identified as a bug will be labeled `🐛 bug`.
10+
- If you'd like to submit a fix for a bug, send a Pull Request from your own fork and mention the Issue number.
11+
- Include a test that isolates the bug and verifies that it was fixed.
12+
- New Features
13+
- If you'd like to accomplish something in the extension that it doesn't already do, describe the problem in a new Github Issue.
14+
- Issues that have been identified as a feature request will be labeled `✨ enhancement`.
15+
- If you'd like to implement the new feature, please wait for feedback from the project maintainers before spending
16+
too much time writing the code. In some cases, `✨ enhancement`s may not align well with the project objectives at
17+
the time.
18+
- Tests, Documentation, Miscellaneous
19+
- If you think the test coverage could be improved, the documentation could be clearer, you've got an alternative
20+
implementation of something that may have more advantages, or any other change we would still be glad hear about
21+
it.
22+
- If its a trivial change, go ahead and send a Pull Request with the changes you have in mind
23+
- If not, open a Github Issue to discuss the idea first.
24+
- Snippets
25+
- To add snippets:
26+
- Add a directory in the `snippets` folder with the name of the language.
27+
- Add one or more files in the language directory with snippets.
28+
- Update the `package.json` to include the snippets you added.
29+
30+
We also welcome anyone to work on any existing issues with the `👋🏽 good first issue` tag.
31+
32+
## Requirements
33+
34+
For a contribution to be accepted:
35+
36+
- The test suite must be complete and pass
37+
- Code must follow existing styling conventions
38+
- Commit messages must be descriptive. Related issues should be mentioned by number.
39+
40+
If the contribution doesn't meet these criteria, a maintainer will discuss it with you on the Issue. You can still
41+
continue to add more commits to the branch you have sent the Pull Request from.
42+
43+
## How To
44+
45+
1. Fork this repository on GitHub.
46+
1. Clone/fetch your fork to your local development machine.
47+
1. Create a new branch (e.g. `issue-12`, `feat.add_foo`, etc) and check it out.
48+
1. Make your changes and commit them. (Did the tests pass? No linting errors?)
49+
1. Push your new branch to your fork. (e.g. `git push myname issue-12`)
50+
1. Open a Pull Request from your new branch to the original fork's `main` branch.

‎LICENSE

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

‎README.md

Lines changed: 63 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,82 @@
1-
1. Generate 2048-bit RSA private key:
1+
# Example Node Proxy for Deepgram
2+
3+
[![Discord](https://dcbadge.vercel.app/api/server/xWRaCDBtW4?style=flat)](https://discord.gg/xWRaCDBtW4) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg?style=flat-rounded)](CODE_OF_CONDUCT.md)
4+
5+
Despite our SDK working in the browser, our API is restricted by CORS. Our SDK has an option to utilise a REST proxy, so you can still benefit from the SDK's functionality in the browser.
6+
7+
> It is your responsibility to secure this application behind your own authentication, or risk others using your Deepgram credit for their own purpose.
8+
9+
This is an example proxy, built using `http-proxy`. Please consider securing it behind your own client authentication before making it available generally.
10+
11+
## Setup
12+
13+
Clone this repository from [GitHub](https://github.com/deepgram-devs/deepgram-node-proxy).
14+
15+
## Initial installation
16+
17+
Install the dependencies to be able to run this application.
18+
19+
```sh
20+
npm i
21+
```
22+
23+
## Configuring your SSL Identity
24+
25+
Run the following to generate an PKCS12 file, to act as your SSL indentity when making a secure request to the Deepgram API. This does not affect your ability to run this proxy behind it's own SSL.
26+
27+
### Generate 2048-bit RSA private key:
228

329
```sh
430
openssl genrsa -out key.pem 2048
531
```
632

7-
2. Generate a Certificate Signing Request:
33+
### Generate a Certificate Signing Request:
834

935
```sh
1036
openssl req -new -sha256 -key key.pem -out csr.csr
1137
```
1238

13-
3. Generate a self-signed x509 certificate suitable for use on web servers.
39+
### Generate a self-signed x509 certificate suitable for use on web servers.
1440

1541
```sh
1642
openssl req -x509 -sha256 -days 365 -key key.pem -in csr.csr -out certificate.pem
1743
```
1844

19-
4. Create SSL identity file in PKCS12 as mentioned here
45+
### Create SSL identity file in PKCS12 as mentioned here
2046

2147
```sh
2248
openssl pkcs12 -export -out certificate.p12 -inkey key.pem -in certificate.pem
2349
```
50+
51+
## Setting up your environment variables
52+
53+
Copy the `sample.env` to `.env` and fill out the variables.
54+
55+
```sh
56+
ALLOWED_ORIGIN=http://localhost:3000 # the origin of the application making the REST requests to Deepgram
57+
PORT=4433 # the port you intend to run your proxy on
58+
DEEPGRAM_API_KEY=5364knj5hgbnipjgp9h490g84h245h524h # your Deepgram API with atleast the usage:write scope
59+
```
60+
61+
## Running locally
62+
63+
```sh
64+
npm run dev
65+
```
66+
67+
# Development and Contributing
68+
69+
Interested in contributing? We ❤️ pull requests!
70+
71+
To make sure our community is safe for all, be sure to review and agree to our
72+
[Code of Conduct](./CODE_OF_CONDUCT.md). Then see the
73+
[Contribution](./CONTRIBUTING.md) guidelines for more information.
74+
75+
# Getting Help
76+
77+
We love to hear from you so if you have questions, comments or find a bug in the
78+
project, let us know! You can either:
79+
80+
- [Open an issue in this repository](https://github.com/deepgram-devs/deepgram-node-proxy/issues/new)
81+
- [Join the Deepgram Discord Community](https://discord.gg/xWRaCDBtW4)
82+
- [Join the Deepgram Github Discussions Community](https://github.com/orgs/deepgram/discussions)

0 commit comments

Comments
 (0)