Skip to content

feat: Unkey-Next.js - Open AI Image generator template [SIDE QUEST]#2619

Closed
Khaan25 wants to merge 2 commits intounkeyed:mainfrom
Khaan25:feat/ai-image-generator
Closed

feat: Unkey-Next.js - Open AI Image generator template [SIDE QUEST]#2619
Khaan25 wants to merge 2 commits intounkeyed:mainfrom
Khaan25:feat/ai-image-generator

Conversation

@Khaan25
Copy link
Contributor

@Khaan25 Khaan25 commented Oct 30, 2024

What does this PR do?
Fixes #2150

Created a AI Image generator app with Next.js 15 and protected the endpoint using Unkey. It uses Redis to store the the response returned from OpenAI (Image URL). We've a limit of 2 per 30 minutes. We've loading, error state, response output, image.

Link to the repo:
https://github.com/Khaan25/ai-image-generator

Live link:
https://ai-image-generator-zia-unkey.vercel.app/

Screenshots

1
3

Summary by CodeRabbit

  • New Features
    • Added a new project entry showcasing the use of Unkey with Next.js for an AI Image Generator.
    • Included a link to the corresponding GitHub repository for further exploration.

@changeset-bot
Copy link

changeset-bot bot commented Oct 30, 2024

⚠️ No Changeset found

Latest commit: 6669533

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

@vercel
Copy link

vercel bot commented Oct 30, 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 30, 2024 4:32pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Oct 30, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new entry to the documentation for projects utilizing Unkey for API protection. It specifically adds a contribution titled "AI Image Generator Nextjs API with Unkey" by Khaan25, which includes a link to the corresponding GitHub repository. This entry maintains the established format of previous entries and does not include modifications to existing content or structure.

Changes

Files Change Summary
oss.gg/7_create_a_template.md Added new entry: 30-October-2024 by Khaan25 AI Image Generator Nextjs API with Unkey

Assessment against linked issues

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

Possibly related issues

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.

@vercel
Copy link

vercel bot commented Oct 30, 2024

@Khaan25 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@github-actions
Copy link
Contributor

github-actions bot commented Oct 30, 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: 1

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

60-60: Update framework name formatting.

The entry looks good, but please update the framework name from "Nextjs" to "Next.js" to match the official spelling.

-» 30-October-2024 by Khaan25 [AI Image Generator Nextjs API with Unkey](https://github.com/Khaan25/ai-image-generator)
+» 30-October-2024 by Khaan25 [AI Image Generator Next.js API with Unkey](https://github.com/Khaan25/ai-image-generator)
🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: The official spelling of this programming framework is “Next.js”.
Context: ...ber-2024 by Khaan25 [AI Image Generator Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 7c76890 and 6669533.

📒 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: ...ber-2024 by Khaan25 [AI Image Generator Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)


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

» 30-October-2024 by Khaan25 [AI Image Generator Nextjs API with Unkey](https://github.com/Khaan25/ai-image-generator)
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 does not fully meet the stated requirements:

  • ✅ MIT license is present
  • ❌ README.md lacks a proper quickstart guide (only contains default Next.js template content)
  • ✅ No duplicate template found at unkey.com/templates (404 response confirmed)

Please update the README.md with:

  • Project-specific description
  • Environment variables setup
  • Unkey integration steps
  • API usage examples
🔗 Analysis chain

Verify repository requirements.

Let's verify that the repository meets all the stated requirements:

  • MIT license
  • README.md with quickstart guide
  • No duplicate with existing templates at unkey.com/templates
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify repository requirements

# Test 1: Check for LICENSE file and its content
echo "Checking LICENSE file..."
gh repo view Khaan25/ai-image-generator | grep -i "license"

# Test 2: Check for README.md
echo "Checking README.md..."
gh repo view Khaan25/ai-image-generator | grep -i "readme"

# Test 3: Check repository contents
echo "Checking repository structure..."
gh repo view Khaan25/ai-image-generator --json files

Length of output: 1718


Script:

#!/bin/bash
# Let's try a different approach using gh api directly

# Check repository details including license and readme
echo "Checking repository details..."
gh api repos/Khaan25/ai-image-generator

# Check repository contents
echo -e "\nChecking repository contents..."
gh api repos/Khaan25/ai-image-generator/contents

# Check for existing templates at unkey.com
echo -e "\nChecking unkey.com templates..."
curl -s https://unkey.dev/templates || echo "Could not access unkey.com templates"

Length of output: 18494


Script:

#!/bin/bash
# Let's check the README.md content to verify if it has a quickstart guide
echo "Checking README.md content..."
gh api repos/Khaan25/ai-image-generator/contents/README.md | jq -r '.content' | base64 -d

# Let's also try to get templates from unkey.dev using a different approach
echo -e "\nChecking unkey.dev templates..."
curl -L -s https://unkey.dev/templates || echo "Could not access templates"

Length of output: 259328


Script:

#!/bin/bash
# Let's check the repository directly using GitHub API

# Check repository details including license and readme
echo "Checking repository details..."
curl -s -H "Accept: application/vnd.github+json" \
     "https://api.github.com/repos/Khaan25/ai-image-generator"

# Check repository contents to verify README.md and LICENSE
echo -e "\nChecking repository contents..."
curl -s -H "Accept: application/vnd.github+json" \
     "https://api.github.com/repos/Khaan25/ai-image-generator/contents"

# Get README.md content to verify quickstart guide
echo -e "\nChecking README.md content..."
curl -s -H "Accept: application/vnd.github+json" \
     "https://api.github.com/repos/Khaan25/ai-image-generator/contents/README.md" | \
     jq -r '.content' | base64 -d 2>/dev/null || echo "Could not decode README content"

Length of output: 20715


Script:

#!/bin/bash
# Let's try to get the README content directly using curl
echo "Fetching README content..."
curl -L -s "https://raw.githubusercontent.com/Khaan25/ai-image-generator/main/README.md"

# Also check if this template exists on unkey.dev
echo -e "\nChecking for duplicate template..."
curl -L -s "https://unkey.dev/templates/ai-image-generator" | grep -i "404"

Length of output: 18619

🧰 Tools
🪛 LanguageTool

[uncategorized] ~60-~60: The official spelling of this programming framework is “Next.js”.
Context: ...ber-2024 by Khaan25 [AI Image Generator Nextjs API with Unkey](https://github.com/Khaa...

(NODE_JS)

@chronark
Copy link
Collaborator

I think this is too similar to https://www.unkey.com/templates/ai-billing

@chronark chronark closed this Oct 30, 2024
@Khaan25
Copy link
Contributor Author

Khaan25 commented Oct 31, 2024

You can say but that also has billing credits based. Whereas this one is rate limited, there's a difference, isn't it?

@Khaan25
Copy link
Contributor Author

Khaan25 commented Oct 31, 2024

@chronark

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[🕹️] SIDE QUESTS: https://go.unkey.com/ossgg-challenges

2 participants