docs: add hono and cloudflare workers template repo #2452

Devansh-Baghel · 2024-10-15T19:26:16Z

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.

Repository for the starter template

Fixes #2451

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?

See the deployed API, go to /secret route and refresh 2 times to be ratelimited.

Or run locally with the following setup

1. Clone the repository

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

2. Configure environment variables

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

cp .dev.vars.example .dev.vars

3. Install dependencies and start your server

Install all dependencies from package.json:

npm install

Now start your development server:

npm run dev

Server will now be running at http://localhost:8787

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 template for using Unkey with the Hono framework in Cloudflare Workers.
- Included a link to the corresponding GitHub repository for easy access.
- Documented the new entry with proper attribution and date for clarity.

…sion

changeset-bot · 2024-10-15T19:26:20Z

⚠️ No Changeset found

Latest commit: 2221916

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-15T19:26:23Z

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 15, 2024 7:27pm

vercel · 2024-10-15T19:26:25Z

@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-15T19:26:29Z

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

coderabbitai · 2024-10-15T19:28:46Z

📝 Walkthrough

Walkthrough

The pull request updates the oss.gg/7_create_a_template.md document by adding a new entry under the "Your turn" section. This entry presents a template for utilizing Unkey with the Hono framework in Cloudflare Workers. It includes attribution to Devansh Baghel, a link to the corresponding GitHub repository, and the date of the entry is noted as 16-October-2024.

Changes

Files	Change Summary
oss.gg/7_create_a_template.md	Added a new entry: `» 16-October-2024 by Devansh Baghel [Hono & Cloudflare Workers Unkey Ratelimit Starter](https://github.com/Devansh-Baghel/hono-unkey-ratelimit-starter)`

Assessment against linked issues

Objective	Addressed	Explanation
Create a template of using some framework or language to build an API and protect it with Unkey. (#2451)	✅

Possibly related issues

[oss.gg hackathon] Oak sever template with Unkey rate limiting #2306: This issue involves creating a template using a different framework (Oak) with Unkey, which aligns with the overall goal of providing templates.
[oss.gg hackathon] adding starter template for hono. #2344: This issue also focuses on creating a starter template for Hono with Cloudflare Workers and Unkey, directly related to the changes made in this PR.

Possibly related PRs

[oss.gg] side quest : added another framework; hono on cloudflare edge #2345: This PR adds a starter template for the Hono framework using Unkey, which is directly related to the main PR's updates on templates.
feat: Unkey-flask template [SIDE QUEST] #2174: This PR introduces a template for Flask using Unkey, which aligns with the main PR's updates to the template documentation.
chore: Rust + Axum template [SIDE QUEST] #2237: This PR adds a Rust + Axum template using Unkey, consistent with the main PR's theme of documenting various Unkey templates.

Suggested labels

:joystick: 750 points, hacktoberfest

Suggested reviewers

mcstepp
chronark
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.

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 a8b7cd6 and 2221916.

📒 Files selected for processing (1)

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

🧰 Additional context used

oss.gg/7_create_a_template.md

chronark · 2024-10-29T13:32:06Z

/award 750

oss-gg · 2024-10-29T13:32:10Z

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

feat: add hono and cloudflare workers template repo for oss.gg submis…

2221916

…sion

Devansh-Baghel requested review from perkinsjr, chronark, mcstepp and MichaelUnkey as code owners October 15, 2024 19:26

github-actions bot added Needs Approval Needs approval from Unkey 🕹️ oss.gg labels Oct 15, 2024

vercel bot deployed to Preview – engineering October 15, 2024 19:27 View deployment

coderabbitai bot reviewed Oct 15, 2024

View reviewed changes

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

chronark closed this Oct 29, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add hono and cloudflare workers template repo #2452

docs: add hono and cloudflare workers template repo #2452

Devansh-Baghel commented Oct 15, 2024 •

edited by coderabbitai bot

Loading

changeset-bot bot commented Oct 15, 2024

vercel bot commented Oct 15, 2024 •

edited

Loading

vercel bot commented Oct 15, 2024

github-actions bot commented Oct 15, 2024 •

edited

Loading

coderabbitai bot commented Oct 15, 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

coderabbitai bot left a comment

chronark commented Oct 29, 2024

oss-gg bot commented Oct 29, 2024

docs: add hono and cloudflare workers template repo #2452

docs: add hono and cloudflare workers template repo #2452

Conversation

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

What does this PR do?

Type of change

How should this be tested?

1. Clone the repository

2. Configure environment variables

3. Install dependencies and start your server

Checklist

Required

Appreciated

Summary by CodeRabbit

changeset-bot bot commented Oct 15, 2024

⚠️ No Changeset found

vercel bot commented Oct 15, 2024 • edited Loading

vercel bot commented Oct 15, 2024

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

coderabbitai bot commented Oct 15, 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

coderabbitai bot left a comment

Choose a reason for hiding this comment

chronark commented Oct 29, 2024

oss-gg bot commented Oct 29, 2024

Devansh-Baghel commented Oct 15, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Oct 15, 2024 •

edited

Loading

github-actions bot commented Oct 15, 2024 •

edited

Loading

coderabbitai bot commented Oct 15, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)