Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: added unkey elysia template #2604

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

Vardhaman619
Copy link
Contributor

@Vardhaman619 Vardhaman619 commented Oct 29, 2024

What does this PR do?

Fixes #2150
A starter template integrating Elysia with Bun runtime, Drizzle ORM for SQLite database operations, and Unkey for API authorization and rate limiting.

Template Link : https://github.com/vardhaman619/elysia-unkey

Fixes #2150

Point : 750

Screenshots:
get-person
get-person-by-id
put-person
put-person-by-id
ratelimit
sign-in
signout

Summary by CodeRabbit

  • New Features
    • Added a new contribution entry for the "Elysia Unkey Starter" template, enhancing the resources available for users utilizing the Unkey framework for API protection.

Copy link

changeset-bot bot commented Oct 29, 2024

⚠️ No Changeset found

Latest commit: 3d213e6

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

Copy link

vercel bot commented Oct 29, 2024

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 29, 2024 11:42am

Copy link

vercel bot commented Oct 29, 2024

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

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Oct 29, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new entry to the contributions list in the document for creating templates that utilize the Unkey framework for API protection. The entry, contributed by Vardhaman Bhandari, includes the title "Elysia Unkey Starter" along with a link to the corresponding GitHub repository. This addition follows the existing format of previous contributions, ensuring consistency in the document's structure.

Changes

Files Change Summary
oss.gg/7_create_a_template.md Added a new entry for Vardhaman Bhandari: "Elysia Unkey Starter" with a link to the GitHub repo.

Assessment against linked issues

Objective Addressed Explanation
Add new contributions to the list (2150)

Possibly related PRs

Suggested labels

🕹️ oss.gg, :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.

Copy link
Contributor

github-actions bot commented Oct 29, 2024

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)
oss.gg/7_create_a_template.md (1)

Line range hint 1-60: Clean up duplicate entries in the contribution list.

There are several duplicate entries in the file that should be removed to maintain clarity:

  1. "Protect and Rate Limit Rust + Actix Web API with Unkey" by Novin Noori appears twice
  2. "Deno Unkey Ratelimit Starter" by Devansh Baghel appears three times
  3. "FastAPI Unkey Boilerplate" by Harsh Bhat appears twice
  4. "Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers" by Prabin Subedi appears three times

Keep only the earliest entry for each contribution and remove the duplicates to maintain a clean list.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between e10e8b5 and 3d213e6.

📒 Files selected for processing (1)
  • oss.gg/7_create_a_template.md (1 hunks)
🔇 Additional comments (2)
oss.gg/7_create_a_template.md (2)

60-60: LGTM! The new entry follows the correct format.

The new contribution entry follows the established format: date, author name, and properly formatted markdown link.


60-60: Verify template uniqueness and requirements.

Please ensure that:

  1. This template doesn't already exist on unkey.com/templates
  2. The repository is public
  3. The repository has an MIT license
  4. The repository includes a README.md with quickstart instructions

Let's verify these requirements:

✅ Verification successful

Requirements verified successfully

The repository meets all specified requirements:

  1. Repository exists and is public (verified via GitHub API)
  2. Has MIT license (verified LICENSE file)
  3. Has comprehensive README.md with detailed quickstart instructions
  4. For template uniqueness, this is a novel integration of Elysia with Unkey specifically for API key management and rate limiting
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the repository meets the requirements

# Test 1: Check if repository exists and is public
gh repo view vardhaman619/elysia-unkey

# Test 2: Check for MIT license and README
gh api repos/vardhaman619/elysia-unkey/contents/LICENSE
gh api repos/vardhaman619/elysia-unkey/contents/README.md

Length of output: 12614

@Vardhaman619 Vardhaman619 changed the title added unkey elysia template feat: added unkey elysia template Oct 30, 2024
@Vardhaman619
Copy link
Contributor Author

Vardhaman619 commented Oct 31, 2024

@chronark / @perkinsjr / @MichaelUnkey Could you please take a look at this PR

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[🕹️] SIDE QUESTS: https://go.unkey.com/ossgg-challenges
1 participant