feat: Unkey-Next.js - Time Based Url Shortner template [SIDE QUEST] #2598
Conversation
Khaan25
requested review from
perkinsjr,
chronark,
mcstepp and
MichaelUnkey
as code owners
|
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
📝 Walkthrough📝 WalkthroughWalkthroughThe pull request updates the document located at Changes
Assessment against linked issues
Possibly related PRs
Suggested labels
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
|
@Khaan25 is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
|
Thank you for following the naming conventions for pull request titles! 🙏 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
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
📒 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)
There was a problem hiding this comment.
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
📒 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:
- Uniqueness: Check if this template is not already listed on unkey.com/templates
- License: Verify MIT license is present
- 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)
| » 28-October-2024 by Khaan25 [Time Based Rate Limited Url Shortner Nextjs API with Unkey](https://github.com/Khaan25/url-shortner-time-based) | ||
|
|
There was a problem hiding this comment.
💡 Codebase verification
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)
|
/award 750 |
|
Awarding Khaan25: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/Khaan25 |
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
Summary by CodeRabbit
Summary by CodeRabbit