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

chore: Next.js Pay-as-you-Go starter kit [SIDE QUEST] #2358

Merged
merged 3 commits into from
Oct 15, 2024

Conversation

unrenamed
Copy link
Contributor

@unrenamed unrenamed commented Oct 12, 2024

What does this PR do?

Adds a starter kit showcasing how to leverage Unkey API to implement Pay-as-you-Go system in your Next.js app powered by Supabase. https://github.com/unrenamed/unkey-nextjs-pay-as-you-go

image

Fixes #2150

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Added new templates for Unkey integration with Flask, Django, Rust (Axum and Actix), and Deno frameworks.
    • Introduced a starter template for Unkey route protection on Cloudflare workers.
    • Launched a Next.js Unkey Pay-as-you-Go starter kit.
    • Included a live link for cost-based rate limiting template.
  • Documentation

    • Updated the "Your turn" section with new template entries and guidelines for submissions.

Copy link

changeset-bot bot commented Oct 12, 2024

⚠️ No Changeset found

Latest commit: 99c1fb8

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

@unrenamed 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 12, 2024

📝 Walkthrough

Walkthrough

The pull request updates the document oss.gg/7_create_a_template.md by adding new entries to the "Your turn" section, showcasing various templates that utilize Unkey with different frameworks. Notable additions include templates for Flask RBAC route protection, Time-Sensitive API Keys, Rust + Axum API protection, and a Next.js Pay-as-you-Go starter kit. The overall structure and submission requirements remain unchanged.

Changes

Files Change Summary
oss.gg/7_create_a_template.md Added new entries for Unkey templates including Flask, Rust, Django, Deno, and Hono frameworks.

Assessment against linked issues

Objective Addressed Explanation
Include new entries for template contributions (#2150)

Possibly related PRs

Suggested reviewers

  • mcstepp
  • chronark
  • perkinsjr
  • MichaelUnkey

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 06ddbc9 and 99c1fb8.

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

40-40: LGTM! The previous issue has been addressed.

The entry for Prabin Subedi's template looks good. The space inside the link text has been removed, addressing the previous review comment. The format is correct, and the description is clear.


41-41: Excellent addition! This aligns perfectly with the PR objectives.

The entry for Nazar Poshtarenko's Next.js Unkey Pay-as-you-Go Starter Kit is well-formatted and clear. This addition directly addresses the main purpose of the PR, which is to introduce a starter kit demonstrating the use of Unkey API for implementing a Pay-as-you-Go system in a Next.js application.


40-41: Overall, these additions enhance the template collection.

Both new entries are well-formatted and provide valuable additions to the Unkey template collection. They align with the project's goals and the specific objectives of this PR. Great job on maintaining consistency and adding relevant content!


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 12, 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 14, 2024 10:38am

Copy link
Contributor

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

39-39: Fix typo and remove spaces in link text

There's a typo in the word "protection" and there are unnecessary spaces in the link text. Please apply the following changes:

-» 11-October-2024 by Prabin Subedi [Starter template for Unkey Route protecttion in Hono Webframework in Cloudflare workers ](https://github.com/prabincankod/hono-unkey-cflare)
+» 11-October-2024 by Prabin Subedi [Starter template for Unkey Route protection in Hono Webframework in Cloudflare workers](https://github.com/prabincankod/hono-unkey-cflare)

This will correct the spelling and resolve the Markdownlint warning MD039 (no-space-in-links).

🧰 Tools
🪛 Markdownlint

39-39: null
Spaces inside link text

(MD039, no-space-in-links)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 919db05 and 86f87bd.

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

39-39: null
Spaces inside link text

(MD039, no-space-in-links)

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

40-40: LGTM! Entry aligns with PR objectives

This entry correctly follows the required format and introduces the Next.js Unkey Pay-as-you-Go Starter Kit, which aligns perfectly with the PR objectives mentioned earlier. The template demonstrates the implementation of a Pay-as-you-Go system using the Unkey API in a Next.js application.


39-40: Summary: New entries align with PR objectives and side quest goals

The two new entries added to this file successfully contribute to the collection of templates for using Unkey with various frameworks. These additions align well with the PR objectives and the side quest goals outlined in issue #2150. The templates provide valuable examples for the community, showcasing how to integrate Unkey with different technologies (Hono and Next.js).

To ensure consistency and maintain the high quality of the document, please address the minor issues mentioned in the previous comment for the Hono template entry.

🧰 Tools
🪛 Markdownlint

39-39: null
Spaces inside link text

(MD039, no-space-in-links)

@chronark
Copy link
Collaborator

small nitpick: switch to lightmode and our logo is gone :D

could you use this svg?
https://go.unkey.com/logo

@chronark
Copy link
Collaborator

and can you help me try it out?
what am I doing wrong?

I just went to the signup page of your hosted example

CleanShot 2024-10-13 at 11 31 12@2x

@chronark chronark self-assigned this Oct 13, 2024
@unrenamed
Copy link
Contributor Author

@chronark I think this is related to how Supabase auth filters "unauthorized" email domains to prevent spam, bots, etc. This should be configurable, but I haven't checked that yet. It definitely supports @gmail.com domain at the moment.

@unrenamed
Copy link
Contributor Author

I can try to use a free Resend account as a custom SMTP to to provide additional email capacity for demo testers. Will do that later today. https://resend.com/blog/how-to-configure-supabase-to-send-emails-from-your-domain

@chronark
Copy link
Collaborator

don't sweat it, a disclaimer that only gmail works would be fine too I think

@chronark
Copy link
Collaborator

update: my gmail doesn't work either, same error

@unrenamed
Copy link
Contributor Author

update: my gmail doesn't work either, same error

I'll add a custom SMTP then 😃

@unrenamed
Copy link
Contributor Author

@chronark I've fixed the logo and another bug related to the app themes.

As for the custom SMTP, I'm afraid I cannot fix that at the moment. Apparently, Resend does not allow to integrate Supabase using free SMTP services and I don't have a custom domain to register within Resend account.

I can remove the links to the demo app deployed to Vercel to not confuse anyone. The starter kit can still be cloned and run locally.

@chronark
Copy link
Collaborator

yeah that's probably best. It's a shame, but advertising it when it's not usable would be frustrating

@unrenamed
Copy link
Contributor Author

Yeah, this is exactly why I should remove it. My bad, I haven't tested this part thoroughly beforehand.

Meanwhile, feel free to test it locally. The screenshot doesn't actually cover the core area of the app 😅

@unrenamed
Copy link
Contributor Author

@chronark I removed all links to the live demo from the code base and repository page.

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

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 86f87bd and 06ddbc9.

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

40-40: null
Spaces inside link text

(MD039, no-space-in-links)

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

41-41: LGTM!

The entry for the Next.js Unkey Pay-as-you-Go Starter Kit is well-formatted and provides all necessary information.


40-41: Summary of changes

The additions to the template list are well-formatted and provide valuable new resources for developers looking to integrate Unkey with different frameworks. The new entries for Hono Webframework and Next.js Pay-as-you-Go maintain the document's structure and adhere to the specified requirements.

These additions enhance the variety of available templates, potentially attracting more developers to use Unkey in their projects.

🧰 Tools
🪛 Markdownlint

40-40: null
Spaces inside link text

(MD039, no-space-in-links)

oss.gg/7_create_a_template.md Outdated Show resolved Hide resolved
@chronark chronark merged commit 4913147 into unkeyed:main Oct 15, 2024
5 of 9 checks passed
Copy link

oss-gg bot commented Oct 15, 2024

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

@unrenamed
Copy link
Contributor Author

unrenamed commented Oct 15, 2024

@chronark Thanks for merging this. Feel free to review my other templates when you get a chance:

#2420
#2376
#2463
#2480

@unrenamed
Copy link
Contributor Author

@chronark just noticed 404 not found on the template page

image

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