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 - Time Based Url Shortner template [SIDE QUEST] #2598

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

I developed a time-based URL shortener app using Next.js 15, featuring endpoint protection with Unkey. The app offers a tiered system for generating both short and shorter URLs, with Redis handling data storage. Links are created via the Unkey API and automatically expire after one minute and stored in Redis.

Once it expires, it also deletes the link.

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

Here's the live link:
url-shortner-time-based-zia-unkey.vercel.app

Screenshots

image
image

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features
    • Added new project examples in the "Your turn" section demonstrating the use of Unkey for API protection and rate limiting.
      • "Protect and Rate Limit Rust + Actix Web API with Unkey" by Novin Noori.
      • "Time Based Rate Limited Url Shortner Nextjs API with Unkey" by Khaan25.

Copy link

changeset-bot bot commented Oct 28, 2024

⚠️ No Changeset found

Latest commit: 8b883b9

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 29, 2024 2:44am

Copy link
Contributor

coderabbitai bot commented Oct 28, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request updates the document located at oss.gg/7_create_a_template.md by adding a new entry under the "Your turn" section. This entry showcases a project titled "Time Based Rate Limited Url Shortner Nextjs API with Unkey" by Khaan25, dated 28-October-2024. No changes were made to the declarations of exported or public entities.

Changes

Files Change Summary
oss.gg/7_create_a_template.md Added a new project under "Your turn" section: "Time Based Rate Limited Url Shortner Nextjs API with Unkey".

Assessment against linked issues

Objective Addressed Explanation
Document new projects utilizing Unkey (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

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

github-actions bot commented Oct 28, 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)

44-44: Fix formatting and spelling in the entry title.

Please update the formatting and spelling in the entry to follow standard conventions:

-» 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API with Unkey]
+» 28-October-2024 by Khaan25 [Time-Based Rate-Limited URL Shortener Next.js API with Unkey]

Changes:

  • Added hyphens to "Time-Based" and "Rate-Limited"
  • Corrected "Url" to "URL"
  • Fixed "Shortner" to "Shortener"
  • Corrected "Nextjs" to "Next.js"
🧰 Tools
🪛 LanguageTool

[uncategorized] ~44-~44: This expression is usually spelled with a hyphen.
Context: ...t-actix) » 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API wi...

(BASED_HYPHEN)


[uncategorized] ~44-~44: The official spelling of this programming framework is “Next.js”.
Context: ...5 [Time Based Rate Limited 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 fd682b9.

📒 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] ~44-~44: This expression is usually spelled with a hyphen.
Context: ...t-actix) » 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API wi...

(BASED_HYPHEN)


[uncategorized] ~44-~44: The official spelling of this programming framework is “Next.js”.
Context: ...5 [Time Based Rate Limited Url Shortner Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)

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

41-41: LGTM!

The entry follows the required schema and links to a valid repository implementing Unkey with Rust + Actix Web.


44-45: Verify implementation matches PR objectives.

The repository should implement:

  • Time-based URL shortener using Next.js 15
  • URL expiration after one minute
  • Redis for data storage
  • Unkey API integration for endpoint protection
🧰 Tools
🪛 LanguageTool

[uncategorized] ~44-~44: This expression is usually spelled with a hyphen.
Context: ...t-actix) » 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API wi...

(BASED_HYPHEN)


[uncategorized] ~44-~44: The official spelling of this programming framework is “Next.js”.
Context: ...5 [Time Based Rate Limited Url Shortner Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)

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 and framework name.

Please update the following in the project title:

  • "Time Based" should be "Time-Based"
  • "Nextjs" should be "Next.js"
-» 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API with Unkey](https://github.com/Khaan25/url-shortner-time-based)
+» 28-October-2024 by Khaan25 [Time-Based Rate Limited Url Shortner Next.js API with Unkey](https://github.com/Khaan25/url-shortner-time-based)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: This expression is usually spelled with a hyphen.
Context: ...starter) » 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API wi...

(BASED_HYPHEN)


[uncategorized] ~60-~60: The official spelling of this programming framework is “Next.js”.
Context: ...5 [Time Based Rate Limited 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 fd682b9 and 8b883b9.

📒 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: This expression is usually spelled with a hyphen.
Context: ...starter) » 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API wi...

(BASED_HYPHEN)


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

(NODE_JS)

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

60-61: LGTM! Entry follows the document structure.

The new entry maintains consistency with the existing format and provides all required information.

🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: This expression is usually spelled with a hyphen.
Context: ...starter) » 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API wi...

(BASED_HYPHEN)


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

(NODE_JS)


60-60: Verify repository compliance with side quest requirements.

Please ensure the repository meets all requirements:

  1. Uniqueness: Check if this template is not already listed on unkey.com/templates
  2. License: Verify MIT license is present
  3. Documentation: Confirm README.md includes quickstart instructions
#!/bin/bash
# Check repository for required files and content
gh repo view Khaan25/url-shortner-time-based --json "files,readme,license"
🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: This expression is usually spelled with a hyphen.
Context: ...starter) » 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API wi...

(BASED_HYPHEN)


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

(NODE_JS)

Comment on lines +60 to +61
» 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API with Unkey](https://github.com/Khaan25/url-shortner-time-based)

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

⚠️ Potential issue

Please clean up the following duplicate entries in the document

The following entries appear multiple times and should be consolidated:

  • "Protect and Rate Limit Rust + Actix Web API with Unkey" by Novin Noori (10-October-2024)
  • "Deno Unkey Ratelimit Starter" by Devansh Baghel (10-October-2024)
  • "FastAPI Unkey Boilerplate" by Harsh Bhat (10-October-2024)
  • "Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers" by Prabin Subedi (11-October-2024)

Each entry should appear only once in chronological order.

🔗 Analysis chain

Please clean up duplicate entries in the document.

There are several duplicate entries in the document for contributors like Devansh Baghel, Novin Noori, and others. This affects the document's clarity and maintenance.

Consider removing the duplicate entries to maintain a clean history. For example:

  • "Deno Unkey Ratelimit Starter" appears multiple times
  • "Protect and Rate Limit Rust + Actix Web API with Unkey" is duplicated
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find duplicate entries in the document
rg -A 1 '» \d{2}-[A-Za-z]+-2024 by .+\[.+\]\(.+\)' oss.gg/7_create_a_template.md | sort | uniq -d

Length of output: 1214


Script:

#!/bin/bash
# Let's try a different approach to find duplicate entries
# First, let's see the content of the file
cat oss.gg/7_create_a_template.md

Length of output: 3802

🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: This expression is usually spelled with a hyphen.
Context: ...starter) » 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API wi...

(BASED_HYPHEN)


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

(NODE_JS)

@chronark
Copy link
Collaborator

/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