feat: Creating a template of some framework or language and protecting it using Unkey #2422

shreykx · 2024-10-14T17:19:53Z

Fixes #2150

Adds an Unkey Fastify boilerplate for Ratelimiting.

Link to Repo- https://github.com/shreykx/unkey-fastify

Summary by CodeRabbit

New Features
- Added a new project entry showcasing a template for using the Unkey framework to build APIs.
- Included project details for "Fastify Route Ratelimiting With Unkey Boilerplate" with a link to the GitHub repository.

changeset-bot · 2024-10-14T17:19:57Z

⚠️ No Changeset found

Latest commit: adc6e78

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

vercel · 2024-10-14T17:20:00Z

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 18, 2024 7:25pm

vercel · 2024-10-14T17:20:01Z

@shreykx is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2024-10-14T17:20:01Z

📝 Walkthrough

Walkthrough

The pull request introduces a new entry to a project list showcasing templates for using the Unkey framework to build APIs. Specifically, it adds a project titled "Fastify Route Ratelimiting With Unkey Boilerplate" by Shrey, including a link to the GitHub repository. The new entry follows the established format and structure of previous submissions, maintaining consistency in the documentation.

Changes

File Path	Change Summary
oss.gg/7_create_a_template.md	Added new project entry: `14-October-2024 by Shrey [Fastify Route Ratelimiting With Unkey Boilerplate](https://github.com/shreykx/unkey-fastify)`

Assessment against linked issues

Objective	Addressed	Explanation
Add a new entry of a project template for Unkey (2150)	✅

Possibly related issues

[oss.gg hackathon] Template for Rust Actix Web #2292: This issue involves creating a template for Rust Actix Web, which aligns with the PR's goal of adding API templates.

Possibly related PRs

feat: Unkey-flask template [SIDE QUEST] #2174: Adds a Flask template using Unkey, similar to the Fastify template added in this PR.
chore: Unkey PDF Viewer template [SIDE QUEST] #2191: Introduces new requirements for creating templates with Unkey, relevant to the main PR's focus.
feat: Example app showcasing cost based unkey ratelimiting #2231: Showcases a cost-based rate limiting project, contributing to the list of projects using Unkey.
chore: Rust + Axum template [SIDE QUEST] #2237: Adds a Rust + Axum template, expanding the list of projects utilizing Unkey.
feat: Unkey FastAPI boilerplate [SIDE QUEST] #2307: Adds a FastAPI boilerplate project, relevant as it contributes to the same list of projects.

Suggested labels

🕹️ oss.gg, :joystick: 750 points

Suggested reviewers

mcstepp
chronark
perkinsjr

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 6bd6d03 and adc6e78.

📒 Files selected for processing (1)

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

🚧 Files skipped from review as they are similar to previous changes (1)

oss.gg/7_create_a_template.md

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.

CLAassistant · 2024-10-14T17:20:04Z

All committers have signed the CLA.

github-actions · 2024-10-14T17:20:06Z

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

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

oss.gg/7_create_a_template.md (1)
44-44: Approved with minor formatting suggestion.

The new entry follows the established format correctly. However, there's a minor formatting inconsistency:

Please remove the trailing period at the end of the line to maintain consistency with other entries:
-» 14-October-2024 by Shrey **[Fastify Route Ratelimiting With Unkey Boilerplate](https://github.com/shreykx/unkey-fastify)**.
+» 14-October-2024 by Shrey **[Fastify Route Ratelimiting With Unkey Boilerplate](https://github.com/shreykx/unkey-fastify)**
🧰 Tools

🪛 Markdownlint

44-44: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between a2797b1 and 6bd6d03.

📒 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

44-44: Punctuation: '.'
Trailing punctuation in heading

(MD026, no-trailing-punctuation)

oss.gg/7_create_a_template.md

shreykx · 2024-10-14T17:33:10Z

This is my first time opening a PR..

shreykx · 2024-10-16T13:45:22Z

pls review it

chronark · 2024-10-28T12:06:53Z

Hey, we already have a fastify template

Update 7_create_a_template.md

6bd6d03

shreykx requested review from perkinsjr, chronark, mcstepp and MichaelUnkey as code owners October 14, 2024 17:19

github-actions bot added hacktoberfest 🕹️ oss.gg labels Oct 14, 2024

vercel bot deployed to Preview – engineering October 14, 2024 17:20 View deployment

shreykx changed the title ~~[🕹️] SIDE QUEST- Creating a template of some framework or language and protecting it using Unkey~~ feat: Creating a template of some framework or language and protecting it using Unkey Oct 14, 2024

coderabbitai bot reviewed Oct 14, 2024

View reviewed changes

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

Merge branch 'main' into patch-1

adc6e78

vercel bot deployed to Preview – engineering October 18, 2024 19:25 View deployment

chronark closed this Oct 28, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Creating a template of some framework or language and protecting it using Unkey #2422

feat: Creating a template of some framework or language and protecting it using Unkey #2422

shreykx commented Oct 14, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 14, 2024 •

edited

Loading

vercel bot commented Oct 14, 2024 •

edited

Loading

vercel bot commented Oct 14, 2024

coderabbitai bot commented Oct 14, 2024 •

edited

Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related 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

CLAassistant commented Oct 14, 2024 •

edited

Loading

github-actions bot commented Oct 14, 2024 •

edited

Loading

coderabbitai bot left a comment

shreykx commented Oct 14, 2024

shreykx commented Oct 16, 2024

chronark commented Oct 28, 2024

feat: Creating a template of some framework or language and protecting it using Unkey #2422

feat: Creating a template of some framework or language and protecting it using Unkey #2422

Conversation

shreykx commented Oct 14, 2024 • edited by coderabbitai bot Loading

Summary by CodeRabbit

Summary by CodeRabbit

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

⚠️ No Changeset found

vercel bot commented Oct 14, 2024 • edited Loading

vercel bot commented Oct 14, 2024

coderabbitai bot commented Oct 14, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related 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

CLAassistant commented Oct 14, 2024 • edited Loading

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

coderabbitai bot left a comment

Choose a reason for hiding this comment

shreykx commented Oct 14, 2024

shreykx commented Oct 16, 2024

chronark commented Oct 28, 2024

shreykx commented Oct 14, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 14, 2024 •

edited

Loading

vercel bot commented Oct 14, 2024 •

edited

Loading

coderabbitai bot commented Oct 14, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

CLAassistant commented Oct 14, 2024 •

edited

Loading

github-actions bot commented Oct 14, 2024 •

edited

Loading