fix: update clone instructions and SDK dependencies for all examples#362
Conversation
- Python SDK Demo README: add urBackend/ prefix to cd path - Social Demo README: fix repo URL to geturbackend/urBackend, add urBackend/ prefix - Kanban README: add clone instructions with urBackend/ prefix - Kanban server: replace file: SDK dependency with published 0.4.2 - Templates.jsx: update all readme blocks with correct clone + cd instructions
|
Warning Review limit reached
Next review available in: 5 minutes Enable usage-based reviews in Billing to review now. Otherwise, wait until the next included review is available. How can I continue?After more reviews become available, a review can be triggered using the To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based reviews. How do review limits work?CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan review availability. For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, additional reviews become available more gradually as earlier reviews age out of the rolling window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
📝 WalkthroughWalkthroughUpdates local setup instructions for React, Kanban, Python, and Social examples, aligns repository and documentation links with the canonical repository, and changes Kanban to use the published SDK version ChangesTemplate setup workflow
Estimated code review effort: 2 (Simple) | ~10 minutes Possibly related issues
Possibly related PRs
Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In `@apps/web-dashboard/src/pages/Templates.jsx`:
- Around line 58-59: Update the Terminal 2 startup instructions in the Templates
page so they first navigate to the urBackend/examples/sdk-kanban example
directory, then install dependencies and start the client; preserve the existing
client startup commands.
- Around line 62-63: Update the setup instructions in Templates.jsx to document
the complete Kanban schema from examples/sdk-kanban/README.md, including
required fields for the boards and tasks collections and RLS configured with
ownerField=ownerId. Keep the existing Auth and collection setup steps while
making the schema and ownership settings explicit enough for the app’s CRUD
operations.
- Around line 55-64: Update the Kanban setup instructions around the
server/client startup commands to configure environment variables first:
document both server/.env.example and client/.env.example, including
VITE_URBACKEND_PK and URBACKEND_SECRET_KEY, and instruct users to create the
corresponding .env files before running npm install and npm start/dev. Mention
that Vite-loaded environment changes require restarting the client server.
In `@examples/sdk-kanban/README.md`:
- Around line 12-19: Renumber the README setup headings following “Dashboard
Setup” so “Environment Variables” becomes step 3 and “Installation & Run”
becomes step 4, preserving the existing heading text and sequence.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro Plus
Run ID: da07707e-6187-420a-a389-13fc30ca9ba2
📒 Files selected for processing (5)
apps/web-dashboard/src/pages/Templates.jsxexamples/python-sdk-demo/README.mdexamples/sdk-kanban/README.mdexamples/sdk-kanban/server/package.jsonexamples/social-demo/README.md
- Environment Variables: step 3 (was incorrectly labeled as 2) - Installation & Run: step 4 (was incorrectly labeled as 3)
…tails - Add environment variable configuration steps (server/.env and client/.env) - Document complete collection schemas with RLS settings - Add note about Vite requiring server restart for env changes - Clarify client startup runs from urBackend/examples/sdk-kanban
|
|
||
| ## Setup | ||
| \`\`\`bash | ||
| git clone https://github.com/geturbackend/urBackend.git |
There was a problem hiding this comment.
Useparticular folder cloning.
1. Clone the repository without downloading the files
git clone --no-checkout --depth 1 <repository_url> <destination_folder>
2. Enter the repository directory
cd <destination_folder>
3. Enable sparse-checkout in cone mode
git sparse-checkout init --cone
4. Specify the folder you want to clone
git sparse-checkout set <path/to/desired/folder>
5. Download the files
git checkout main
- Add Option 1: Full Clone (existing method) - Add Option 2: Sparse Checkout (recommended for faster setup) - Sparse checkout clones only the template folder without full repo
| cd urBackend/examples/react-sdk-demo | ||
| npm install |
There was a problem hiding this comment.
You can add the same for all the examples na?
@Nitin-kumar-yadav1307
2 participants
fix #360
Overview
This PR fixes the template setup instructions in the urBackend dashboard and example READMEs to ensure users can reliably fetch and run the selected examples from a clean clone.
Problem Statement
The source-based template workflow had inconsistent setup instructions:
cdpathyash-pouranik/urBackendinstead ofgeturbackend/urBackend)file:../../../sdks/urbackend-sdk) which doesn't work outside the monorepoSolution
Updated all example READMEs and dashboard metadata to use consistent, correct clone instructions with the canonical repository URL and proper directory paths.
Files Changed
1.
examples/python-sdk-demo/README.mdChange: Added
urBackend/prefix to cd path2.
examples/social-demo/README.mdChanges:
https://github.com/geturbackend/urBackend.giturBackend/prefix to clone pathgeturbackend/urBackend3.
examples/sdk-kanban/README.mdChange: Added clone instructions with correct path
4.
examples/sdk-kanban/server/package.jsonChange: Replaced local file dependency with published package
5.
apps/web-dashboard/src/pages/Templates.jsxChange: Updated all template README blocks with correct clone + cd instructions
urBackend/examples/react-sdk-demopathurBackend/examples/python-sdk-demopathAcceptance Criteria
✅ All clone instructions use canonical repository URL
https://github.com/geturbackend/urBackend.git✅ All cd paths include cloned repository directory
cd urBackend/examples/<template-name>✅ Kanban setup succeeds without local SDK dependency
@urbackend/sdk@0.4.2instead of local file reference✅ Template cards and READMEs describe the same workflow
✅ Users can follow instructions from clean shell after cloning
Testing
cdpaths includeurBackend/prefixRelated Issues
Summary by CodeRabbit