feat: Unkey-Next.js - Url Shortner template [SIDE QUEST] #2593
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 ↗︎
|
|
@Khaan25 is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
📝 WalkthroughWalkthroughThe 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
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 (
|
|
Thank you for following the naming conventions for pull request titles! 🙏 |
Khaan25
changed the title
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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 in project title.There are two spelling issues in the project title:
- "Nextjs" should be "Next.js" (official framework name)
- "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
📒 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) | |||
There was a problem hiding this comment.
💡 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:
- Adding a
LICENSEfile with the MIT license text - 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:
- Open source visibility
- MIT license
- 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)
|
see comment on #2595 |
|
Awarding Khaan25: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/Khaan25 |
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
Summary by CodeRabbit