chore: Unkey PDF Viewer template [SIDE QUEST]

[unrenamed]

What does this PR do?

Adds a demo app showcasing time-limited access to specific PDF pages, restricting full downloads. Example of protecting digital content with temporary access using Unkey SDK. https://github.com/unrenamed/unkey-pdf-view

Summary by CodeRabbit

Summary by CodeRabbit

• Documentation
  • Updated template creation guidelines for the Unkey framework, including new requirements for checking duplicates, open-source commitment, and licensing under the MIT license.
  • Added two new example projects with links to their GitHub repositories.
  • Retained requirement for a README.md file with a quickstart guide.
  • Introduced a new template entry for "pdf-view," detailing its properties and usage.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 7295727

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]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
unkey-engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 4, 2024 6:59pm

[coderabbitai]

Caution

Review failed

The pull request is closed.

📝 Walkthrough

📝 Walkthrough

Walkthrough

The pull request updates the template creation guidelines for the Unkey framework. It adds new requirements regarding duplicate checks, open-source project commitments, and licensing under the MIT license. Additionally, it retains the requirement for a README.md file with a quickstart guide and introduces two new example projects with links to their GitHub repositories. A new template entry for "pdf-view" has also been added, detailing its properties.

Changes

File Path	Change Summary
oss.gg/7_create_a_template.md	- Added requirement to check for duplicates in existing templates. - Clarified open-source commitment. - Specified MIT licensing requirement. - Retained README.md requirement. - Added two new example entries with links. - Introduced new template entry "pdf-view" with detailed properties.

Possibly related PRs

• feat: Unkey-flask template [SIDE QUEST] #2174: The changes in this PR include the addition of the same entry for Harsh Bhat's project, which was also added in the main PR, indicating a direct connection in the updates to the template documentation.

Suggested labels

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

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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]

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

A member of the Team first needs to authorize it.

[github-actions]

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

[coderabbitai]

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (1)

oss.gg/7_create_a_template.md (1)

Line range hint 6-10: LGTM! Consider adding a clarification about the licensing requirement.

The new requirements are clear and align well with the objectives of the side quest. They provide good guidance for participants and ensure the quality of submissions.

Consider clarifying the licensing requirement. You could add a brief explanation of why the MIT license is required and provide a link to the license text for reference.

🧰 Tools

🪛 LanguageTool

[typographical] ~4-~4: After the expression ‘for example’ a comma is usually used.
Context: ... Unkey with a particular framework. For example [Ratelimit your Next.js routes](https:/...

(COMMA_FOR_EXAMPLE)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Files that changed from the base of the PR and between 600839e and 7acc3f8.

📒 Files selected for processing (1)

• oss.gg/7_create_a_template.md (2 hunks)

🔇 Additional comments (3)

oss.gg/7_create_a_template.md (3)

31-31: LGTM! Entry added correctly.

The new entry for Harsh Bhat's project follows the required schema and provides all necessary information.

---

Line range hint 6-33: Overall changes align well with PR objectives and side quest requirements.

The updates to this file successfully address the PR objectives by:

1. Adding clear requirements for template submissions, ensuring quality and originality.
2. Including new entries that demonstrate the progress of the side quest initiative.
3. Specifically adding the entry for the Unkey PDF Viewer template, which aligns with the main objective of this PR.

These changes contribute to the broader "SIDE QUESTS" initiative and provide a clear record of contributions for the hackathon.

---

32-33: LGTM! Entry added correctly and aligns with PR objectives.

The new entry for Nazar Poshtarenko's project follows the required schema and provides all necessary information. The project title and link match the information provided in the PR objectives, demonstrating time-limited access to specific PDF pages using the Unkey SDK.

To verify the project's alignment with the PR objectives, we can check the repository content:

✅ Verification successful

Verified: Project aligns with PR objectives and uses Unkey SDK

The repository 'unrenamed/unkey-pdf-view' exists and contains multiple references to Unkey packages, APIs, and services throughout the codebase. This strongly indicates that the project is indeed using the Unkey SDK as mentioned in the PR objectives.

While the specific implementation of time-limited access to PDF pages couldn't be directly confirmed through our automated search, the overall use of Unkey in the project is evident. To fully verify the time-sensitive access feature, a manual review of the relevant code would be beneficial.

To complete the verification, please manually check the implementation details related to time-limited access to specific PDF pages using the Unkey SDK.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the content of the Unkey PDF Viewer template repository

# Test: Check if the repository exists and contains expected files
gh repo view unrenamed/unkey-pdf-view --json name,description,readme,licenseInfo

# Test: Check for the presence of Unkey SDK usage in the code
gh api /repos/unrenamed/unkey-pdf-view/contents | jq -r '.[].name' | xargs -I {} gh api /repos/unrenamed/unkey-pdf-view/contents/{} | jq -r '.content' | base64 -d | grep -i 'unkey'

Length of output: 1498

---

Script:

#!/bin/bash
# Description: Verify the content of the Unkey PDF Viewer template repository

# Test: Check if the repository exists and contains expected fields
gh repo view unrenamed/unkey-pdf-view --json name,description,licenseInfo

# Test: Check for the presence of Unkey SDK usage in the code using ast-grep
ast-grep --lang javascript --pattern $'unkey' .

Length of output: 228

---

Script:

#!/bin/bash
# Description: Comprehensive verification of Unkey SDK usage in the repository

# Test 1: Search for the term 'unkey' in all files
rg 'unkey' --ignore-dir=node_modules --ignore-dir=dist

# Test 2: Check for Unkey SDK in package.json (for JavaScript projects)
fd 'package.json' | xargs grep -i 'unkey'

# Test 3: Check for Unkey SDK in other dependency files (e.g., requirements.txt, Pipfile, etc.)
fd 'requirements.txt,Pipfile,go.mod,build.gradle' | xargs grep -i 'unkey'

# Test 4: Search for Unkey SDK references in documentation files
rg 'unkey' --type markdown --type txt

Length of output: 26006

---

Script:

#!/bin/bash
# Description: Enhanced verification of Unkey SDK usage in the repository

# Test 1: Corrected search for the term 'unkey' in all code files excluding node_modules and dist directories
rg 'unkey' --ignore-file node_modules/ --ignore-file dist/ 

# Test 2: Search for import or require statements related to Unkey SDK in JavaScript and TypeScript files
rg 'from\s+["@]unkey' --type js --type jsx --type ts --type tsx

# Test 3: Search for import or require statements related to Unkey SDK in other supported languages
rg 'import\s+.*\s+from\s+["@]unkey' --type python --type go --type java

# Test 4: Verify configuration files for Unkey SDK setup
rg 'unkey' --type yaml --type json --type toml --type env

Length of output: 300304

[CLAassistant]

All committers have signed the CLA.

[chronark]

This is so cool, thanks for sharing
do you mind signing the CLA, then I'll merge it and add it to our unkey.com/templates

[unrenamed]

Glad you liked it, thanks! I've signed the CLA

[chronark]

If you have more ideas, feel free to submit more, each one awards 750 points :)

[oss-gg]

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