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

oss.gg: side quest blog side quest 8, follow the unkey x, starry eyed supporter, create a template [3200 points] #2383

Closed
wants to merge 12 commits into from

Conversation

Yash-1511
Copy link

@Yash-1511 Yash-1511 commented Oct 13, 2024

Description

Completed the challenge of side quest Follow on X, created a template that uses unkey api to protect and gathering five friends to star the repository.

  • Adds a Unkey Hapi.js boilerplate for route protection[750 Points]

https://github.com/Yash-1511/hapi-unkey-template

  • Adds Deno + Hono middleware for unkey[750 Points]

https://github.com/Yash-1511/hono-unkey-deno

Write a blog about unkey api that i use in our application [1500 points]

https://medium.com/@yashp3020/how-i-secured-my-ai-powered-legal-compliance-api-with-unkey-a9df815209b2

follow on X screenshot[50 points]

WhatsApp Image 2024-10-13 at 18 43 09

GitHub Usernames of Friends [150 Points]

  1. @virugamacoder
  2. @harshp421
  3. @Felixcoder308
  4. @nandani-1411
  5. @gtlYashParmar

Screenshots

  1. @virugamacoder
    virugam

  2. @harshp421
    harsh

  3. @Felixcoder308
    parth

  4. @nandani-1411
    nandani

  5. @gtlYashParmar
    yash

Summary by CodeRabbit

Summary by CodeRabbit

  • New Features

    • Added a new participant, Yash Parmar, to the "Follow the Unkey X account" side quest.
    • Introduced new template submissions for using Unkey with Hapi.js and Hono frameworks.
    • Updated the "Use Unkey" document to include a new side quest entry.
  • Updates

    • Updated contribution details in the "Starry-eyed Supporter" document, reflecting the latest participant and date.
    • Revised the date in the "Starry-eyed Supporter" document to reflect the latest contribution.
    • Added a new entry for "Starry-eyed Supporter" with Zia Ur Rehman and a link to a GitHub issue.
    • Updated the "Use Unkey" document with a new entry and revised date.

Copy link

changeset-bot bot commented Oct 13, 2024

⚠️ No Changeset found

Latest commit: 5ceaba6

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 13, 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 23, 2024 7:02am

Copy link
Contributor

coderabbitai bot commented Oct 13, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request includes updates to four documents related to contributions in the "Follow the Unkey X account," "Starry-eyed Supporter," and template submissions for using Unkey with Hapi.js. A new participant, Yash Parmar, is added with specific dates and links to their accounts. Additionally, the last entry in the "Starry-eyed Supporter" document is updated to reflect Yash Parmar as the contributor, along with a new template submission for using Unkey with Hapi.js.

Changes

File Path Change Summary
oss.gg/3_follow_the_unkey_x_account.md New entry added for Yash Parmar on 13-October-2024 with a link to their X account.
oss.gg/4_starry_eyed_supporter.md Last entry updated to reflect Yash-1511 as the contributor on 13-October-2024.
oss.gg/7_create_a_template.md New entry added for a Hapi.js template submission by Yash Parmar with a link to the GitHub repo.
oss.gg/8_use_unkey_blog.md Date updated to 16-October-2024 by Yash-1511 and a new entry added for 18-October-2024.

Possibly related PRs

Suggested labels

🕹️ oss.gg, :joystick: 150 points, :joystick: 750 points, hacktoberfest, Needs Approval

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 c5599aa and ff5a125.

📒 Files selected for processing (1)
  • oss.gg/7_create_a_template.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • oss.gg/7_create_a_template.md

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

@Yash-1511 is attempting to deploy a commit to the Unkey Team on Vercel.

A member of the Team first needs to authorize it.

@CLAassistant
Copy link

CLAassistant commented Oct 13, 2024

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

github-actions bot commented Oct 13, 2024

Hey there and thank you for opening this pull request! 👋🏼

We require pull request titles to follow the Conventional Commits specification and it looks like your proposed title needs to be adjusted.
Here is an example:

<type>[optional scope]: <description>
fix: I fixed something for Unkey

Details:

No release type found in pull request title "oss.gg: side quest blog side quest 8, follow the unkey x, starry eyed supporter, create a template [3200 points]". Add a prefix to indicate what kind of release this pull request corresponds to. For reference, see https://www.conventionalcommits.org/

Available types:
 - feat: A new feature
 - fix: A bug fix
 - docs: Documentation only changes
 - style: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
 - refactor: A code change that neither fixes a bug nor adds a feature
 - perf: A code change that improves performance
 - test: Adding missing tests or correcting existing tests
 - build: Changes that affect the build system or external dependencies (example scopes: gulp, broccoli, npm)
 - ci: Changes to our CI configuration files and scripts (example scopes: Travis, Circle, BrowserStack, SauceLabs)
 - chore: Other changes that don't modify src or test files
 - revert: Reverts a previous commit

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/3_follow_the_unkey_x_account.md (1)

50-52: Format the X account link as a clickable link

The new entry looks good and follows the existing format. However, to improve consistency and address the Markdownlint warning, please format the X account link as a clickable link.

Apply this change to format the link:

 » 13-October-2024 by [Yash Parmar](@Yash-1511)
-» Link to Account: https://x.com/yashp3020
+» Link to Account: [https://x.com/yashp3020](https://x.com/yashp3020)

This change will make the link clickable and resolve the Markdownlint warning about bare URLs.

🧰 Tools
🪛 Markdownlint

51-51: null
Bare URL used

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 7972170 and ab2918e.

📒 Files selected for processing (3)
  • oss.gg/3_follow_the_unkey_x_account.md (1 hunks)
  • oss.gg/4_starry_eyed_supporter.md (1 hunks)
  • oss.gg/7_create_a_template.md (1 hunks)
✅ Files skipped from review due to trivial changes (1)
  • oss.gg/4_starry_eyed_supporter.md
🧰 Additional context used
🪛 Markdownlint
oss.gg/3_follow_the_unkey_x_account.md

51-51: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)
oss.gg/3_follow_the_unkey_x_account.md (1)

50-52: LGTM! Verify contributor information

The new entry for Yash Parmar is consistent with the existing format and contains all the required information. It's also placed in the correct chronological order.

To ensure the accuracy of the information, please run the following script to verify the GitHub username and X account:

This script will help verify that both the GitHub username and X account are valid and accessible.

✅ Verification successful

Contributor information verified

Both GitHub user Yash-1511 and X account yashp3020 have been successfully verified and exist.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Verify GitHub username and X account

# Check if the GitHub user exists
gh api users/Yash-1511 > /dev/null 2>&1
if [ $? -eq 0 ]; then
  echo "GitHub user Yash-1511 exists"
else
  echo "GitHub user Yash-1511 does not exist"
fi

# Check if the X account exists (Note: This is a basic check and may not be 100% reliable)
curl -s -o /dev/null -w "%{http_code}" https://x.com/yashp3020 | grep 200 > /dev/null
if [ $? -eq 0 ]; then
  echo "X account yashp3020 exists"
else
  echo "X account yashp3020 may not exist or is not accessible"
fi

Length of output: 266

🧰 Tools
🪛 Markdownlint

51-51: null
Bare URL used

(MD034, no-bare-urls)

oss.gg/7_create_a_template.md (1)

44-45: LGTM! Verify license and README

The new entry for Yash Parmar's Hapi.js Unkey Boilerplate is correctly formatted and aligns with the PR objectives. It's a unique contribution, not duplicating any existing templates.

Please run the following script to verify the MIT license and README.md requirements:

✅ Verification successful

License and README Verified ✅

The Hapi.js Unkey Boilerplate repository includes an MIT License and a README.md with a Quickstart section as required. All verification checks have passed.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify MIT license and README.md in the Hapi.js Unkey Boilerplate repository

# Clone the repository
git clone https://github.com/Yash-1511/hapi-unkey-template.git
cd hapi-unkey-template

# Check for MIT license
if grep -q "MIT License" LICENSE; then
  echo "MIT License found"
else
  echo "MIT License not found"
fi

# Check for README.md and quickstart section
if [ -f README.md ]; then
  echo "README.md found"
  if grep -qi "quickstart" README.md; then
    echo "Quickstart section found in README.md"
  else
    echo "Quickstart section not found in README.md"
  fi
else
  echo "README.md not found"
fi

# Clean up
cd ..
rm -rf hapi-unkey-template

Length of output: 484

@Yash-1511 Yash-1511 changed the title oss.gg: side quest follow the unkey x, starry eyed supporter, create a template oss.gg: side quest blog side quest 8, follow the unkey x, starry eyed supporter, create a template Oct 15, 2024
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 (2)
oss.gg/8_use_unkey_blog.md (1)

Line range hint 21-23: Consider adjusting the template entry date.

The new entry maintains the document structure and provides a template for future contributors. However, the date (01-October-2024) is earlier than the previous entry (16-October-2024), which might cause confusion about the chronological order of entries.

Consider one of the following options:

  1. Adjust the template date to be after the most recent entry, e.g., "DD-Month-2024" or a specific future date.
  2. Add a comment explaining that the date should be updated by the next contributor.

Example implementation:

-» 01-October-2024 by YOUR NAME
+» DD-Month-2024 by YOUR NAME  # Update this date when adding your entry
oss.gg/3_follow_the_unkey_x_account.md (1)

49-50: LGTM! Minor formatting suggestion for consistency.

The new entry for Yash Parmar is correctly added and follows the required schema. Great job!

For consistency with some other entries, consider enclosing the X account link in angle brackets:

 » 13-October-2024 by [Yash Parmar](@Yash-1511)
-» Link to Account: https://x.com/yashp3020
+» Link to Account: <https://x.com/yashp3020>
🧰 Tools
🪛 Markdownlint

50-50: null
Bare URL used

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between ab2918e and 586da59.

📒 Files selected for processing (3)
  • oss.gg/3_follow_the_unkey_x_account.md (1 hunks)
  • oss.gg/7_create_a_template.md (1 hunks)
  • oss.gg/8_use_unkey_blog.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • oss.gg/7_create_a_template.md
🧰 Additional context used
🪛 Markdownlint
oss.gg/3_follow_the_unkey_x_account.md

50-50: null
Bare URL used

(MD034, no-bare-urls)


53-53: null
Bare URL used

(MD034, no-bare-urls)


56-56: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (2)
oss.gg/8_use_unkey_blog.md (1)

19-19: LGTM! Verify contributor information.

The date update and contributor name change are consistent with the PR objectives. The entry format follows the provided schema correctly.

To ensure the accuracy of the contributor information, please run the following script:

✅ Verification successful

Contributor information verified.

The contributor "Yash-1511" exists and is associated with PR #2383, as confirmed by the verification scripts.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the contributor's GitHub username and PR association

# Test: Check if the GitHub user exists and is associated with this PR
gh api users/Yash-1511 --jq '.login' || echo "User not found"
gh pr view 2383 --json author --jq '.author.login'

Length of output: 107

oss.gg/3_follow_the_unkey_x_account.md (1)

50-56: Markdownlint warnings about bare URLs can be ignored.

The static analysis tool Markdownlint has flagged bare URLs on lines 50, 53, and 56. However, these warnings can be safely ignored for the following reasons:

  1. The document specifically requests URLs in this format.
  2. Changing the URL format would deviate from the intended structure and consistency of the document.
  3. In this context, bare URLs are more readable and align with the document's purpose.

No action is required to address these warnings.

🧰 Tools
🪛 Markdownlint

50-50: null
Bare URL used

(MD034, no-bare-urls)


53-53: null
Bare URL used

(MD034, no-bare-urls)


56-56: null
Bare URL used

(MD034, no-bare-urls)

@chronark
Copy link
Collaborator

@Yash-1511 could you update your template to use the new way of checking keys

https://github.com/Yash-1511/hapi-unkey-template/blob/c1fbd1a6b9773df1d736cac660f8e45b8098a69e/server.js#L48
you should pass in the apiID too

const { result, error } = await verifyKey({ key: "key_123", apiId: "api_123" });

@chronark chronark self-assigned this Oct 16, 2024
@Yash-1511
Copy link
Author

Yash-1511 commented Oct 16, 2024

@Yash-1511 could you update your template to use the new way of checking keys

https://github.com/Yash-1511/hapi-unkey-template/blob/c1fbd1a6b9773df1d736cac660f8e45b8098a69e/server.js#L48 you should pass in the apiID too

const { result, error } = await verifyKey({ key: "key_123", apiId: "api_123" });

Hey @chronark , I have updated verifykey with apiId.

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/3_follow_the_unkey_x_account.md (1)

50-50: Consider enclosing the URL in angle brackets.

To address the Markdownlint warning and improve consistency with some other entries in the list, consider enclosing the X account URL in angle brackets.

Here's the suggested change:

-» Link to Account: https://x.com/yashp3020
+» Link to Account: <https://x.com/yashp3020>
🧰 Tools
🪛 Markdownlint

50-50: null
Bare URL used

(MD034, no-bare-urls)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 586da59 and e13ae40.

📒 Files selected for processing (2)
  • oss.gg/3_follow_the_unkey_x_account.md (2 hunks)
  • oss.gg/4_starry_eyed_supporter.md (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • oss.gg/4_starry_eyed_supporter.md
🧰 Additional context used
🪛 Markdownlint
oss.gg/3_follow_the_unkey_x_account.md

50-50: null
Bare URL used

(MD034, no-bare-urls)

🔇 Additional comments (1)
oss.gg/3_follow_the_unkey_x_account.md (1)

49-51: LGTM! New entry added correctly.

The new entry for Yash Parmar has been added following the existing format and maintains the chronological order of the list. This is consistent with the document's structure and the PR objectives.

🧰 Tools
🪛 Markdownlint

50-50: null
Bare URL used

(MD034, no-bare-urls)

@chronark
Copy link
Collaborator

It looks like https://github.com/FelixCoder308 was created just to star the oss.gg repositories, that's against the rules

@Yash-1511
Copy link
Author

Yash-1511 commented Oct 20, 2024

It looks like https://github.com/FelixCoder308 was created just to star the oss.gg repositories, that's against the rules

Actually, the account wasn't created just for starring those repositories. My friend started freelancing around 3-4 months ago, which is when they created this GitHub account. While there may not be many public repositories, there are some private ones. You can verify this by checking the API at the link provided:
https://api.github.com/users/FelixCoder308.

Also, could you please share the rulebook or guidelines you're referring to? I'd like to review the specific rules you're mentioning.

Screenshot_2024-10-20-13-19-35-96_40deb401b9ffe8e1df2f1cc5ba480b12.jpg

@Yash-1511 Yash-1511 changed the title oss.gg: side quest blog side quest 8, follow the unkey x, starry eyed supporter, create a template oss.gg: side quest blog side quest 8, follow the unkey x, starry eyed supporter, create a template [3200 points] Oct 22, 2024
@chronark
Copy link
Collaborator

/award 3200

@chronark chronark closed this Oct 28, 2024
Copy link

oss-gg bot commented Oct 28, 2024

Awarding Yash-1511: 3200 points 🕹️ Well done! Check out your new contribution on oss.gg/Yash-1511

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.

3 participants