feat: Unkey Express rate limiting example #2484
Conversation
FaheemOnHub
requested review from
perkinsjr,
chronark,
mcstepp and
MichaelUnkey
as code owners
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 WalkthroughWalkthroughThe pull request introduces updates to the document Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@FaheemOnHub is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
|
Thank you for following the naming conventions for pull request titles! 🙏 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
oss.gg/7_create_a_template.md (1)
39-39: Minor: Remove spaces inside link textThere are spaces inside the link text for Prabin Subedi's entry. While this doesn't affect functionality, it's inconsistent with Markdown best practices and other entries in the list.
Please apply the following change to remove the spaces:
-» 11-October-2024 by Prabin Subedi [Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers ](https://github.com/prabincankod/hono-unkey-cflare) +» 11-October-2024 by Prabin Subedi [Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers](https://github.com/prabincankod/hono-unkey-cflare)🧰 Tools
🪛 Markdownlint
39-39: null
Spaces inside link text(MD039, no-space-in-links)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- oss.gg/7_create_a_template.md (1 hunks)
🧰 Additional context used
🪛 Markdownlint
oss.gg/7_create_a_template.md
39-39: null
Spaces inside link text(MD039, no-space-in-links)
🔇 Additional comments (3)
oss.gg/7_create_a_template.md (3)
39-39: Approved: Typo correctionThe typographical error in Prabin Subedi's entry has been correctly fixed, changing "protecttion" to "protection". This improves the overall quality of the document.
🧰 Tools
🪛 Markdownlint
39-39: null
Spaces inside link text(MD039, no-space-in-links)
39-43: Summary: Changes align with PR objectivesThe changes made to this file are consistent with the PR objectives and side quest requirements:
- A new contribution entry for the "Express Unkey Ratelimit Starter" has been added, showcasing the implementation of rate limiting using Unkey with Express.js.
- A typographical error in an existing entry has been corrected.
These updates contribute to the ongoing hackathon initiative described in issue #2150. The file continues to serve its purpose as a record of contributions for the side quest.
For further improvement, consider standardizing the formatting across all entries, particularly regarding spaces in link texts.
🧰 Tools
🪛 Markdownlint
39-39: null
Spaces inside link text(MD039, no-space-in-links)
42-42: Approved: New contribution entryThe new entry for Faheem Mushtaq's "Express Unkey Ratelimit Starter" has been correctly added. It follows the required format and provides all necessary information. This contribution aligns well with the side quest objectives outlined in the PR summary and linked issue #2150.
To ensure the contribution meets all requirements, please run the following verification script:
✅ Verification successful
Verified: Contribution entry meets all requirements
The repository
FaheemOnHub/UnkeyExpressExampleis public, contains aREADME.mdwith setup instructions, and is licensed under the MIT License. The new contribution entry is consistent with the PR objectives.🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Verify the new contribution entry # Check if the repository exists and is public echo "Verifying repository accessibility..." gh repo view FaheemOnHub/UnkeyExpressExample # Check for README.md file echo "Checking for README.md..." gh api repos/FaheemOnHub/UnkeyExpressExample/contents/README.md # Check for MIT license echo "Checking for MIT license..." gh api repos/FaheemOnHub/UnkeyExpressExample/licenseLength of output: 6442
|
@perkinsjr kindly check this! |
|
I'm not sure about this one. If you're running express, it probably makes way more sense to use a stateful ratelimiter right on your server. |
|
@chronark but it is an example to show that how you can use unkey for rate limiting |
What does this PR do?
Showcases rate limiting using Unkey and Express.js. This can help showcase Unkey's power using Express.js
Fixes: #2150
Github repo: https://github.com/FaheemOnHub/UnkeyExpressExample
Summary by CodeRabbit
New Features
Bug Fixes