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

feat: Svelte Unkey Route protection example #2474

Closed
wants to merge 1 commit into from

Conversation

harshsbhat
Copy link
Contributor

@harshsbhat harshsbhat commented Oct 17, 2024

What does this PR do?

Example app to showcase route protection for Svelte using Unkey

Fixes: #2150

Github repo: https://github.com/harshsbhat/unkey-svelte

Summary by CodeRabbit

  • New Features

    • Added a new project entry titled "Svelte Route Protection Example" by Harsh Bhat, enhancing the resource for open-source contributions.
  • Documentation

    • Updated the template creation document to reflect the new project while maintaining the existing structure and guidelines.

Copy link

changeset-bot bot commented Oct 17, 2024

⚠️ No Changeset found

Latest commit: 2a98a11

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
Contributor

coderabbitai bot commented Oct 17, 2024

📝 Walkthrough

Walkthrough

The pull request updates the document oss.gg/7_create_a_template.md by adding a new entry under the "Your turn" section. This entry details a project titled "Svelte Route Protection Example" by Harsh Bhat, dated 17-October-2024. The format of the entry aligns with previous contributions, maintaining the structure for documenting open-source projects.

Changes

File Change Summary
oss.gg/7_create_a_template.md Added new entry: » 17-October-2024 by Harsh Bhat [Svelte Route Protection Example](https://github.com/harshsbhat/unkey-svelte)

Assessment against linked issues

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

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 8b37287 and 2a98a11.

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

42-42: LGTM! New entry follows the correct format.

The new entry for the Svelte Route Protection Example by Harsh Bhat is correctly formatted and appears to meet the visible requirements. It provides a unique contribution using the Svelte framework.

To ensure full compliance with the requirements, please verify:

  1. The project has an MIT license.
  2. The repository includes a README.md with quickstart instructions.
  3. The example is not already listed on unkey.com/templates.

You can use the following script to check for the presence of LICENSE and README.md files:

✅ Verification successful

LGTM! The new entry fully complies with all requirements.

The new entry for the Svelte Route Protection Example by Harsh Bhat is correctly formatted, includes an MIT license, and contains a README.md with quickstart instructions. It provides a unique contribution using the Svelte framework.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the presence of LICENSE and README.md files in the repository

# Test: Check for LICENSE and README.md files
gh repo view harshsbhat/unkey-svelte --json files --jq '.files[].name' | grep -E 'LICENSE|README.md'

# Expected output: Should list both LICENSE and README.md files

Length of output: 1225


Script:

#!/bin/bash
# Description: Verify the presence of an MIT LICENSE and README.md files in the repository

# Check for MIT License
license=$(gh api repos/harshsbhat/unkey-svelte --jq '.license.spdx_id')
if [[ "$license" == "MIT" ]]; then
  echo "MIT license found"
else
  echo "MIT license not found or different license present"
fi

# Check for README.md file
if gh api repos/harshsbhat/unkey-svelte/contents/README.md --silent; then
  echo "README.md found"
else
  echo "README.md not found"
fi

Length of output: 250


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

@harshsbhat 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

github-actions bot commented Oct 17, 2024

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

Copy link

vercel bot commented Oct 17, 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 17, 2024 6:56am

@chronark
Copy link
Collaborator

/award 750

@chronark chronark closed this Oct 29, 2024
Copy link

oss-gg bot commented Oct 29, 2024

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

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