docs: add oak & deno sever template with unkey rate limiting #2308

Devansh-Baghel · 2024-10-10T17:35:03Z

What does this PR do?

Completed oss.gg task of creating a starter template to showcase how you can use Unkey with a particular framework.

Note: There is already an example with deno in the examples repo, but it is outdated and doesn't work with the latest deno version 2.0, also that example doesn't implement ratelimiting which i have added in my version.

Fixes #2306

Type of change

Bug fix (non-breaking change which fixes an issue)
Chore (refactoring code, technical debt, workflow improvements)
Enhancement (small improvements)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
This change requires a documentation update

How should this be tested?

1. Clone the repository

git clone https://github.com/Devansh-Baghel/deno-unkey-ratelimit-starter.git
cd deno-unkey-ratelimit-starter

2. Set up environment variables

Copy the .env.example file to .env file in the root directory and add your Unkey root key:

cp .env.example .env

3. Run your server

deno task start

Then go to http://localhost:8000/secret and refresh the page a few times to see that the api has been ratelimited.

Checklist

Required

Appreciated

If a UI change was made: Added a screen recording or screenshots to this PR
Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

New Features
- Added a new side quest for creating a template using the Unkey framework to build an API.
- Introduced a feedback mechanism for participants to earn points based on their setup experience with Unkey.
- Updated contributions list with a new entry for "Deno Unkey Ratelimit Starter" by Devansh Baghel.

…unkey

changeset-bot · 2024-10-10T17:35:07Z

⚠️ No Changeset found

Latest commit: a780fe6

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2024-10-10T17:35:11Z

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

The pull request updates the documentation to include a new entry for a side quest focused on creating a template using the Unkey framework for API development. It instructs participants to document their setup experiences and provide feedback, with specific requirements for the template, including being open source and MIT licensed. Recent contributions to the template repository are highlighted, including a new entry for the "Deno Unkey Ratelimit Starter" by Devansh Baghel.

Changes

File Path	Change Summary
oss.gg/7_create_a_template.md	Added a new entry for a side quest on creating a template with Unkey, detailing setup feedback and requirements. Included recent contributions, notably a new entry for "Deno Unkey Ratelimit Starter" by Devansh Baghel.

Assessment against linked issues

Objective	Addressed	Explanation
Create a template to build an API and protect it with Unkey (2306)	✅
Implement public and protected routes with rate limiting (2306)	✅

Possibly related PRs

chore: added template to templates page #2074: This PR adds a new template for "unkey-trpc-ratelimit," which is related to the main PR's focus on creating templates for using the Unkey framework.
feat: Unkey-flask template [SIDE QUEST] #2174: This PR introduces a new entry for a Flask template using Unkey, which aligns with the main PR's updates regarding contributions and templates.
chore: Unkey PDF Viewer template [SIDE QUEST] #2191: This PR updates requirements for creating templates with Unkey, including the need for open-source licensing and README.md files, which is relevant to the main PR's changes.
feat: Create a template with Unkey #2272: This PR adds a new side quest for creating templates with Unkey, directly related to the main PR's focus on documenting setup experiences and contributions.
docs: add oak & deno sever template with unkey rate limiting #2308: This PR includes a new entry for a Deno Unkey Ratelimit Starter, which is a specific implementation related to the main PR's updates on contributions and templates.

Suggested labels

hacktoberfest

Suggested reviewers

mcstepp
perkinsjr
MichaelUnkey

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

vercel · 2024-10-10T17:35:11Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 12, 2024 8:42am

CLAassistant · 2024-10-10T17:35:13Z

All committers have signed the CLA.

vercel · 2024-10-10T17:35:13Z

@Devansh-Baghel is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

github-actions · 2024-10-10T17:35:18Z

Thank you for following the naming conventions for pull request titles! 🙏

coderabbitai

Actionable comments posted: 1

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 4991094 and af9ee94.

📒 Files selected for processing (1)

oss.gg/7_create_a_template.md (1 hunks)

🧰 Additional context used

oss.gg/7_create_a_template.md

oss-gg · 2024-10-12T08:42:00Z

Awarding Devansh-Baghel: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/Devansh-Baghel

…unkey (unkeyed#2308) Co-authored-by: Andreas Thomas <[email protected]>

* fix:breadcrum-cache-issue * chore:rename-revalidateMytag * refactor: move-revalidateTag * refactor: extract tags into reusable utility * feat: add template * Update 3_follow_the_unkey_x_account.md (#2323) * fix: capture uniqueness error and return it correctly (#2337) * docs: getVerifications instead of get (#2329) * Update 3_follow_the_unkey_x_account.md (#2324) Followed unkey on Twitter Co-authored-by: Andreas Thomas <[email protected]> * fix: transaction ...: in use: for query (#2278) * fix: transaction ...: in use: for query - Fixes #2197 - The error is caused by the cache revalidation happening in the background, so we have a racecondition with the other queries we are running in the insertGenericAuditLogs function * docs: explain for future self * fix: another racecondition also bulk insert auditLogs and auditLogTargets * [autofix.ci] apply automated fixes --------- Co-authored-by: chronark <[email protected]> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> * fix: handle undefined ratelimits * Update 3_follow_the_unkey_x_account.md (#2338) * fix: handle case when blogs array is empty * [oss.gg] side quest : added another framework; hono on cloudflare workers. (#2345) * fix: weird spacing in changelog by removing the extra gap (#2340) * fix: weird spacing in changelog * feat: formatted * oss.gg: create a template for ratelimiting a oak server in deno with unkey (#2308) Co-authored-by: Andreas Thomas <[email protected]> * follow unkey on X #2252 (#2315) Co-authored-by: Your Name <[email protected]> * Follow the Unkey X account: @unkeydev Complete! (#2332) * Update 3_follow_the_unkey_x_account.md * Update 3_follow_the_unkey_x_account.md --------- Co-authored-by: Andreas Thomas <[email protected]> * fix(www): analytics bento code snippet is not readable (#2311) - add hover effect to analytics bento removing gradient background - make copy code button sticky to top-right corner - impl independent vertical scrolls for language switcher and code editor * Update 7_create_a_template.md * Update 7_create_a_template.md * chore(deps-dev): bump @content-collections/core from 0.6.2 to 0.7.2 (#2255) Bumps @content-collections/core from 0.6.2 to 0.7.2. --- updated-dependencies: - dependency-name: "@content-collections/core" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * fix: order audit logs by time, show latest on top (#2295) * feat: add template * feat: Unkey FastAPI boilerplate (#2307) * feat: add template * feat: follow unkey on X (#2357) * Update 6_record_onboarding.md (#2301) * fix: reset input fields in API delete dialog after reopening (#2316) * fix: reset input fields in API delete dialog after reopening * refactor: remove unnecessary useEffect and utilize existing onOpenChange function for dialog * refactor: removed unused imports * Update 3_follow_the_unkey_x_account.md (#2364) Added name to the followed list. Co-authored-by: Andreas Thomas <[email protected]> * ci: add label * feat: add hover to input fields * Added gaps and width for md (#2371) * docs: update overview.mdx (#2384) avaliable -> available * oss.gg side quest 3_follow_the_unkey_x_account.md (#2399) Followed the unkey x account * feat: Following unkey acc on twitter #2407 (#2408) * Feat: Followed Unkey on X * Feat: Followed Unkey on Twitter --------- Co-authored-by: Andreas Thomas <[email protected]> * resolve merge conflicts * resolve merge conflicts --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: chronark <[email protected]> Co-authored-by: Emily Marie Ahtúnan <[email protected]> Co-authored-by: Harsh Shrikant Bhat <[email protected]> Co-authored-by: Aritra Sadhukhan <[email protected]> Co-authored-by: Flo <[email protected]> Co-authored-by: autofix-ci[bot] <114827586+autofix-ci[bot]@users.noreply.github.com> Co-authored-by: Devang Rakholiya <[email protected]> Co-authored-by: Prabin <[email protected]> Co-authored-by: ZiaCodes <[email protected]> Co-authored-by: Devansh Baghel <[email protected]> Co-authored-by: Shreenarayan jaiswal <[email protected]> Co-authored-by: Your Name <[email protected]> Co-authored-by: Chirag Arora <[email protected]> Co-authored-by: Nazar Poshtarenko <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Saketh Pavan Goti <[email protected]> Co-authored-by: Teddy ASSIH <[email protected]> Co-authored-by: Vardhaman Bhandari <[email protected]> Co-authored-by: Atharva_404 <[email protected]> Co-authored-by: Rishi <[email protected]> Co-authored-by: Ikko Eltociear Ashimine <[email protected]> Co-authored-by: Ayan Mondal <[email protected]> Co-authored-by: Kunal Arya <[email protected]>

Devansh-Baghel and others added 2 commits October 10, 2024 22:09

oss.gg: create a template for ratelimiting a oak server in deno with …

bb34333

…unkey

Merge branch 'unkeyed:main' into main

af9ee94

Devansh-Baghel requested review from perkinsjr, chronark, mcstepp and MichaelUnkey as code owners October 10, 2024 17:35

github-actions bot added the 🕹️ oss.gg label Oct 10, 2024

vercel bot deployed to Preview – engineering October 10, 2024 17:36 View deployment

coderabbitai bot reviewed Oct 10, 2024

View reviewed changes

oss.gg/7_create_a_template.md Outdated Show resolved Hide resolved

Merge branch 'unkeyed:main' into main

1e8daa4

vercel bot deployed to Preview – engineering October 11, 2024 20:59 View deployment

Devansh-Baghel mentioned this pull request Oct 11, 2024

docs: integrated unkey's ratelimiter into my project and wrote a blog post on the same #2347

Merged

18 tasks

chronark added the 🕹️ 750 points label Oct 12, 2024

Merge branch 'main' into main

a780fe6

chronark merged commit e84175f into unkeyed:main Oct 12, 2024
7 of 12 checks passed

vercel bot deployed to Preview – engineering October 12, 2024 08:42 View deployment

AkshayBandi027 pushed a commit to AkshayBandi027/unkey that referenced this pull request Oct 14, 2024

oss.gg: create a template for ratelimiting a oak server in deno with …

8b3c9cc

…unkey (unkeyed#2308) Co-authored-by: Andreas Thomas <[email protected]>

AkshayBandi027 pushed a commit to AkshayBandi027/unkey that referenced this pull request Oct 14, 2024

oss.gg: create a template for ratelimiting a oak server in deno with …

a74c234

…unkey (unkeyed#2308) Co-authored-by: Andreas Thomas <[email protected]>

coderabbitai bot mentioned this pull request Oct 18, 2024

fix: disable save button when workspace name is empty #2294

Merged

coderabbitai bot mentioned this pull request Nov 25, 2024

chore: Add API Rate limiting to API documentation #2681

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add oak & deno sever template with unkey rate limiting #2308

docs: add oak & deno sever template with unkey rate limiting #2308

Devansh-Baghel commented Oct 10, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 10, 2024 •

edited

Loading

coderabbitai bot commented Oct 10, 2024 •

edited

Loading

Review failed

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

vercel bot commented Oct 10, 2024 •

edited

Loading

CLAassistant commented Oct 10, 2024 •

edited

Loading

vercel bot commented Oct 10, 2024

github-actions bot commented Oct 10, 2024 •

edited

Loading

coderabbitai bot left a comment

oss-gg bot commented Oct 12, 2024

docs: add oak & deno sever template with unkey rate limiting #2308

docs: add oak & deno sever template with unkey rate limiting #2308

Conversation

Devansh-Baghel commented Oct 10, 2024 • edited by coderabbitai bot Loading

What does this PR do?

Type of change

How should this be tested?

1. Clone the repository

2. Set up environment variables

3. Run your server

Checklist

Required

Appreciated

Summary by CodeRabbit

changeset-bot bot commented Oct 10, 2024 • edited Loading

⚠️ No Changeset found

coderabbitai bot commented Oct 10, 2024 • edited Loading

Review failed

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Suggested labels

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

vercel bot commented Oct 10, 2024 • edited Loading

CLAassistant commented Oct 10, 2024 • edited Loading

vercel bot commented Oct 10, 2024

github-actions bot commented Oct 10, 2024 • edited Loading

coderabbitai bot left a comment

Choose a reason for hiding this comment

oss-gg bot commented Oct 12, 2024

Devansh-Baghel commented Oct 10, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 10, 2024 •

edited

Loading

coderabbitai bot commented Oct 10, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

vercel bot commented Oct 10, 2024 •

edited

Loading

CLAassistant commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024 •

edited

Loading