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: add Unkey + Nuxt Image Gallery template [SIDE QUEST] #2591

Closed

Conversation

unrenamed
Copy link
Contributor

@unrenamed unrenamed commented Oct 27, 2024

What does this PR do?

Adds a template that showcases how to secure your Nuxt.js media library with time-sensitive API keys.

Language: Vue
Framework: Nuxt.js
Feature: time-sensitive API keys for secure access via RBAC

https://github.com/unrenamed/unkey-nuxt-image-gallery

Fixes #2150

Summary by CodeRabbit

  • New Features
    • Added a new project entry titled "Secure Your Media Library with Unkey" to the documentation, linking to its GitHub repository.

Copy link

changeset-bot bot commented Oct 27, 2024

⚠️ No Changeset found

Latest commit: 0fc6488

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 27, 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 27, 2024 10:02pm

Copy link

vercel bot commented Oct 27, 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 27, 2024

📝 Walkthrough

Walkthrough

The pull request introduces a new entry to the documentation for projects utilizing the Unkey framework. Specifically, it adds a contribution by Nazar Poshtarenko titled "Secure Your Media Library with Unkey," along with a link to the corresponding GitHub repository. The entry is dated 27-October-2024 and adheres to the existing format, ensuring consistency in the documentation style.

Changes

File Path Change Summary
oss.gg/7_create_a_template.md Added new entry: 27-October-2024 by Nazar Poshtarenko Secure Your Media Library with Unkey

Assessment against linked issues

Objective Addressed Explanation
Add a new entry for contributions in the OSS documentation (#2150)

Possibly related issues

Possibly related PRs

Suggested labels

🕹️ oss.gg, :joystick: 750 points, hacktoberfest

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 ca805ac and 0fc6488.

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

57-58: LGTM! The entry follows the correct format.

The new template entry maintains consistency with the established format and provides a unique contribution demonstrating Unkey integration with Nuxt.js.

Let's verify the repository meets all requirements:

✅ Verification successful

Repository requirements verified successfully ✅

The template repository meets all the requirements:

  • Public repository with comprehensive documentation
  • MIT licensed
  • README.md with detailed quickstart guide and setup instructions
  • Unique contribution (no duplicates found)
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify repository requirements for the template

# Test 1: Check if repository exists and is public
echo "Verifying repository accessibility..."
gh repo view unrenamed/unkey-nuxt-image-gallery

# Test 2: Check for MIT license and README
echo "Checking for required files..."
gh api repos/unrenamed/unkey-nuxt-image-gallery/contents/LICENSE -q '.name'
gh api repos/unrenamed/unkey-nuxt-image-gallery/contents/README.md -q '.name'

# Test 3: Verify license type
echo "Verifying license type..."
gh api repos/unrenamed/unkey-nuxt-image-gallery | jq -r '.license.spdx_id'

Length of output: 4696


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
Contributor

github-actions bot commented Oct 27, 2024

Thank you for following the naming conventions for pull request titles! 🙏

@chronark
Copy link
Collaborator

/award 750

@chronark chronark closed this Oct 28, 2024
Copy link

oss-gg bot commented Oct 28, 2024

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

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