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: Unkey-Next.js - Url Shortner template [SIDE QUEST] #2593

Closed
wants to merge 2 commits into from

Conversation

Khaan25
Copy link
Contributor

@Khaan25 Khaan25 commented Oct 28, 2024

What does this PR do?

Fixes #2150

Created a URL Shortner app with Next.js 15 and protected URL shortner endpoint using Unkey. It also has a tier based system to generate shortest url and short url. It uses Redis to store the value

Link to the repo:
https://github.com/Khaan25/url-shortner

Live link:
https://url-shortner-zia-unkey.vercel.app/

Screenshots

image

Summary by CodeRabbit

  • New Features
    • Added a new project entry showcasing "Rate Limit Url Shortner Nextjs API with Unkey" by Khaan25, including a link to the GitHub repository.
  • Documentation
    • Maintained existing structure for project submissions, emphasizing open-source contributions and the requirement for a README.md with a quickstart guide.

Copy link

changeset-bot bot commented Oct 28, 2024

⚠️ No Changeset found

Latest commit: d9e5f59

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 28, 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 28, 2024 3:45pm

Copy link

vercel bot commented Oct 28, 2024

@Khaan25 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 28, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new entry to a project list that showcases the use of Unkey for API protection. The entry, "Rate Limit Url Shortner Nextjs API with Unkey," created by Khaan25, includes a link to the project's GitHub repository. The overall structure and submission requirements remain unchanged, with the new entry appended to the end of the existing list.

Changes

File Path Change Summary
oss.gg/7_create_a_template.md Added a new project entry: "Rate Limit Url Shortner Nextjs API with Unkey" by Khaan25, with a link to the GitHub repository.

Assessment against linked issues

Objective Addressed Explanation
Add a new entry for contributions (2150)

Possibly related PRs

Suggested labels

joystick: 750 points

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 28, 2024

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

@Khaan25 Khaan25 changed the title feat: added my line feat: Unkey-Next.js - Url Shortner template [SIDE QUEST] Oct 28, 2024
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: 1

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

60-60: Fix spelling in project title.

There are two spelling issues in the project title:

  1. "Nextjs" should be "Next.js" (official framework name)
  2. "Shortner" should be "Shortener"

Here's the corrected version:

-» 28-October-2024 by Khaan25 [Rate Limit Url Shortner Nextjs API with Unkey](https://github.com/Khaan25/url-shortner)
+» 28-October-2024 by Khaan25 [Rate Limit URL Shortener Next.js API with Unkey](https://github.com/Khaan25/url-shortner)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: The official spelling of this programming framework is “Next.js”.
Context: ...024 by Khaan25 [Rate Limit Url Shortner Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 8fb9d4d and d9e5f59.

📒 Files selected for processing (1)
  • oss.gg/7_create_a_template.md (1 hunks)
🧰 Additional context used
🪛 LanguageTool
oss.gg/7_create_a_template.md

[uncategorized] ~60-~60: The official spelling of this programming framework is “Next.js”.
Context: ...024 by Khaan25 [Rate Limit Url Shortner Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)

🔇 Additional comments (2)
oss.gg/7_create_a_template.md (2)

60-60: Verify template uniqueness.

As per requirements, please confirm that a similar template doesn't already exist at unkey.com/templates.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: The official spelling of this programming framework is “Next.js”.
Context: ...024 by Khaan25 [Rate Limit Url Shortner Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)


60-61: Format is consistent with requirements.

The new entry follows the correct format for date, attribution, and link structure.

Let's verify if this is a unique contribution:

#!/bin/bash
# Search for any duplicate entries of the URL shortener project
rg -i "url.*short.*next.*unkey" 
🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: The official spelling of this programming framework is “Next.js”.
Context: ...024 by Khaan25 [Rate Limit Url Shortner Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)

@@ -57,4 +57,6 @@ Your turn 👇

» 10-October-2024 by Devansh Baghel [Deno Unkey Ratelimit Starter](https://github.com/Devansh-Baghel/deno-unkey-ratelimit-starter)

» 28-October-2024 by Khaan25 [Rate Limit Url Shortner Nextjs API with Unkey](https://github.com/Khaan25/url-shortner)
Copy link
Contributor

Choose a reason for hiding this comment

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

💡 Codebase verification

Repository requirements need attention

The repository verification shows:

  • ✅ Public repository (visibility: "PUBLIC")
  • ✅ README.md with comprehensive quickstart guide
  • ❌ Missing MIT license

Please add an MIT license to your repository to meet all requirements. You can do this by:

  1. Adding a LICENSE file with the MIT license text
  2. Using GitHub's "Add file" > "Create new file" > Type "LICENSE" > Choose "MIT License" template
🔗 Analysis chain

Verify repository requirements.

Please ensure your repository meets all requirements:

  1. Open source visibility
  2. MIT license
  3. README.md with quickstart guide

Let's verify the repository requirements:

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Check repository contents
gh repo view Khaan25/url-shortner --json isPrivate,description,readme,license

# Check for README.md content
gh api /repos/Khaan25/url-shortner/contents/README.md | jq -r '.content' | base64 -d

Length of output: 1362


Script:

#!/bin/bash
# Check repository visibility and license info
gh repo view Khaan25/url-shortner --json isPrivate,visibility,licenseInfo

# Try direct API call to get README content
gh api /repos/Khaan25/url-shortner/contents/README.md

# List repository contents to verify presence of license and readme
gh api /repos/Khaan25/url-shortner/contents

Length of output: 16393

🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: The official spelling of this programming framework is “Next.js”.
Context: ...024 by Khaan25 [Rate Limit Url Shortner Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)

@chronark
Copy link
Collaborator

see comment on #2595
/award 750

@chronark chronark closed this Oct 29, 2024
Copy link

oss-gg bot commented Oct 29, 2024

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

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
2 participants