[oss.gg hackathon] template: fastify + unkey template #2404
Conversation
Vardhaman619
requested review from
perkinsjr,
chronark,
mcstepp and
MichaelUnkey
as code owners
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@Vardhaman619 is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
📝 Walkthrough📝 WalkthroughWalkthroughThe document Changes
Assessment against linked issues
Possibly related 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 (
|
|
Hey there and thank you for opening this pull request! 👋🏼 We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted. Details: |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
oss.gg/7_create_a_template.md (2)
39-39: Approve typo correction and suggest link text formatting fix.The typo correction from "Route protecttion" to "Route protection" improves the accuracy of the description. However, there's a minor formatting issue with the link text.
To address the Markdownlint warning (MD039) and improve consistency, remove the space at the end of the link text:
-» 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)
39-43: Overall changes look good. Consider adding a newline for improved readability.The changes maintain the document's consistency and improve its content. The entries are well-formatted and chronologically ordered.
To improve readability, consider adding a newline between the entries:
» 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) + » 14-October-2024 by Vardhaman Bhandari [Starter template for Fastify API Route protection and Ratelimiting using Unkey](https://github.com/Vardhaman619/fastify-unkey) » 10-October-2024 by Harsh Bhat [FastAPI Unkey Boilerplate](https://github.com/harshsbhat/unkey-fastapi-boilerplate)This small change will enhance the visual separation between entries and make the document easier to read.
🧰 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)
| @@ -37,7 +36,9 @@ Your turn 👇 | |||
|
|
|||
| » 10-October-2024 by Novin Noori [Protect and Rate Limit Rust + Actix Web API with Unkey](https://github.com/djnovin/unkey-rust-actix) | |||
| » 10-October-2024 by Devansh Baghel [Deno Unkey Ratelimit Starter](https://github.com/Devansh-Baghel/deno-unkey-ratelimit-starter) | |||
| » 11-October-2024 by Prabin Subedi [Starter template for Unkey Route protecttion 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) | |||
| » 14-October-2024 by Vardhaman Bhandari [Starter template for Fastify API Route protection and Ratelimiting using Unkey](https://github.com/Vardhaman619/fastify-unkey) | |||
There was a problem hiding this comment.
💡 Codebase verification
Formatting Inconsistency Detected
The entry by Prabin Subedi has a trailing space in the link text:
[Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers ](https://github.com/prabincankod/hono-unkey-cflare)
Please remove the space before the closing ] to maintain consistent formatting across all entries.
🔗 Analysis chain
LGTM! New entry is consistent and valuable.
The new entry for Vardhaman Bhandari's Fastify API starter template is a great addition. It aligns well with the PR objectives and provides a new, valuable resource for developers looking to integrate Unkey with Fastify.
To ensure consistency across all entries, let's verify the formatting:
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify consistency of entry formatting
# Test: Check if all entries follow the format "» DD-Month-YYYY by Author [Description](URL)"
rg --type md '» \d{2}-[A-Z][a-z]+-\d{4} by .+ \[.+\]\(.+\)' oss.gg/7_create_a_template.md
# Test: Ensure no entries have trailing spaces in the link text
rg --type md '\[.+ \]\(' oss.gg/7_create_a_template.md
Length of output: 1836
|
@chronark @perkinsjr Could you please take a look at this PR when you get a chance? I'd like to close it soon so I can begin working on other issues. |
|
Please add more instructions to your readme. It just tells me how to run it, not how to actually use it? |
Thank you for your feedback! I've updated the README to include detailed instructions on how to use the template, along with information on the available API routes. |
|
@chronark Could you please take a look at this PR |
|
/award 750 |
|
Awarding Vardhaman619: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/Vardhaman619 |
What does this PR do?
This PR adds a new starter template using fastify + unkey
#2150
Closes #2378
Type of change
How should this be tested?
Checklist
Required
pnpm buildpnpm fmtconsole.logsgit pull origin mainAppreciated
Summary by CodeRabbit
New Features
Bug Fixes
Documentation