feat: Unkey-flask template [SIDE QUEST] #2174
Conversation
|
|
@harshsbhat is attempting to deploy a commit to the Unkey Team on Vercel. A member of the Team first needs to authorize it. |
|
Thank you for following the naming conventions for pull request titles! 🙏 |
📝 WalkthroughWalkthroughThe changes involve an update to the document located at Changes
Assessment against linked issues
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
| @@ -26,6 +26,5 @@ Your turn 👇 | |||
|
|
|||
| //////////////////////////// | |||
|
|
|||
| » 01-October-2024 by YOUR NAME | |||
|
|
|||
| » 04-October-2024 by Harsh Bhat [Flask RBAC route protection using unkey](https://github.com/harshsbhat/unkey-flask.git) | |||
There was a problem hiding this comment.
💡 Codebase verification
WARNING: README.md is missing quickstart information.
The repository's README.md does not include quickstart information, which is required for full compliance with the side quest requirements.
- Repository: Flask RBAC route protection using unkey
🔗 Analysis chain
LGTM! Verify repository contents for full compliance.
The new entry follows the correct format and provides a valid GitHub repository link. This aligns with the side quest objective of creating a template using Unkey with a specific framework (Flask in this case).
To ensure full compliance with the side quest requirements, please run the following script to verify the repository contents:
This script will verify:
- The existence of a README.md file with quickstart information.
- The presence of a LICENSE file with MIT license.
Please review the script output to ensure the repository meets all requirements.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Description: Verify the contents of the unkey-flask repository
# Clone the repository
git clone https://github.com/harshsbhat/unkey-flask.git temp_unkey_flask
cd temp_unkey_flask
# Check for README.md
if [ -f README.md ]; then
echo "README.md exists"
# Check if README.md contains "quickstart" or "quick start"
if grep -qi "quickstart\|quick start" README.md; then
echo "README.md contains quickstart information"
else
echo "WARNING: README.md might be missing quickstart information"
fi
else
echo "ERROR: README.md is missing"
fi
# Check for LICENSE file
if [ -f LICENSE ]; then
echo "LICENSE file exists"
# Check if it's MIT license
if grep -q "MIT License" LICENSE; then
echo "Confirmed MIT License"
else
echo "WARNING: License might not be MIT"
fi
else
echo "ERROR: LICENSE file is missing"
fi
# Clean up
cd ..
rm -rf temp_unkey_flask
Length of output: 622
There was a problem hiding this comment.
It doesn't have a quickstart heading, but it does include all the steps to run it, so this is fine
There was a problem hiding this comment.
@chronark, understood. Thanks for clarifying that the README includes all the necessary steps. I'll consider this acceptable for meeting the requirement.
(•ิ_•ิ)?
✏️ Learnings added
Learnt from: chronark
PR: unkeyed/unkey#2174
File: oss.gg/7_create_a_template.md:29-29
Timestamp: 2024-10-04T11:30:53.848Z
Learning: Even if a repository's README.md does not have a 'Quickstart' heading, as long as it includes all the steps to run the project, it meets the requirement for including quickstart information in the README.md.
Note: Learnings are effective only in the context of similar code segments. To apply general coding guidelines, please configure review instructions. You can manage existing learnings in the app.
chronark
changed the title
|
Awarding harshsbhat: 750 points 🕹️ Well done! Check out your new contribution on oss.gg/harshsbhat |
What does this PR do?
Fixes #2150
Created a template to protect role based routes in Flask using Unkey.
Link to the repo:
https://github.com/harshsbhat/unkey-flask.git
Summary by CodeRabbit
New Features
Documentation